Skip to content

Added optional type parameter to AssertObjectExists #218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
CodyKlimkofski wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Added optional type parameter to AssertObjectExists #218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 33 additions & 3 deletions Source/tSQLt.AssertObjectExists.ssp.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,57 @@ GO
---Build+
CREATE PROCEDURE tSQLt.AssertObjectExists
@ObjectName NVARCHAR(MAX),
@Message NVARCHAR(MAX) = ''
@Message NVARCHAR(MAX) = '',
@TypeName NVARCHAR(MAX) = NULL
AS
BEGIN
DECLARE @Msg NVARCHAR(MAX);
DECLARE @ObjectId INT;
DECLARE @ActualType NVARCHAR(128);

IF(@ObjectName LIKE '#%')
BEGIN
IF OBJECT_ID('tempdb..'+@ObjectName) IS NULL
SET @ObjectId = OBJECT_ID('tempdb..'+@ObjectName);
IF @ObjectId IS NULL
BEGIN
SELECT @Msg = '''' + COALESCE(@ObjectName, 'NULL') + ''' does not exist';
EXEC tSQLt.Fail @Message, @Msg;
RETURN 1;
END;

IF @TypeName IS NOT NULL
BEGIN
SELECT @ActualType = type_desc FROM tempdb.sys.objects WHERE object_id = @ObjectId;
IF @ActualType IS NULL OR @ActualType <> UPPER(@TypeName)
BEGIN
SELECT @Msg = '''' + COALESCE(@ObjectName, 'NULL') + ''' exists but is not of type ''' + @TypeName + '''' +
CASE WHEN @ActualType IS NOT NULL THEN ' (found type: ''' + @ActualType + ''')' ELSE '' END;
EXEC tSQLt.Fail @Message, @Msg;
RETURN 1;
END;
END;
END
ELSE
BEGIN
IF OBJECT_ID(@ObjectName) IS NULL
SET @ObjectId = OBJECT_ID(@ObjectName);
IF @ObjectId IS NULL
BEGIN
SELECT @Msg = '''' + COALESCE(@ObjectName, 'NULL') + ''' does not exist';
EXEC tSQLt.Fail @Message, @Msg;
RETURN 1;
END;

IF @TypeName IS NOT NULL
BEGIN
SELECT @ActualType = type_desc FROM sys.objects WHERE object_id = @ObjectId;
IF @ActualType IS NULL OR @ActualType <> UPPER(@TypeName)
BEGIN
SELECT @Msg = '''' + COALESCE(@ObjectName, 'NULL') + ''' exists but is not of type ''' + @TypeName + '''' +
CASE WHEN @ActualType IS NOT NULL THEN ' (found type: ''' + @ActualType + ''')' ELSE '' END;
EXEC tSQLt.Fail @Message, @Msg;
RETURN 1;
END;
END;
END;
RETURN 0;
END;
Expand Down
181 changes: 179 additions & 2 deletions Tests/AssertObjectExistsTests.class.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ BEGIN
EXEC('CREATE SCHEMA MyTestClass;');
CREATE TABLE #Tbl(i int);
EXEC('CREATE PROC MyTestClass.TestCaseA AS EXEC tSQLt.AssertObjectExists ''#Tbl'';');

BEGIN TRY
EXEC tSQLt.Run 'MyTestClass.TestCaseA';
END TRY
Expand All @@ -58,7 +58,184 @@ BEGIN
FROM tSQLt.TestResult;
SELECT 'MyTestClass' Class, 'TestCaseA' TestCase, 'Success' Result
INTO expected;


EXEC tSQLt.AssertEqualsTable 'expected', 'actual';
END;
GO

CREATE PROC AssertObjectExistsTests.test_AssertObjectExists_does_not_call_fail_when_table_exists_with_correct_type
AS
BEGIN
DECLARE @ErrorRaised INT; SET @ErrorRaised = 0;

EXEC('CREATE SCHEMA MyTestClass;');
EXEC('CREATE TABLE MyTestClass.tbl(i int);');
EXEC('CREATE PROC MyTestClass.TestCaseA AS EXEC tSQLt.AssertObjectExists ''MyTestClass.tbl'', '''', ''USER_TABLE'';');

BEGIN TRY
EXEC tSQLt.Run 'MyTestClass.TestCaseA';
END TRY
BEGIN CATCH
SET @ErrorRaised = 1;
END CATCH
SELECT Class, TestCase, Result
INTO actual
FROM tSQLt.TestResult;
SELECT 'MyTestClass' Class, 'TestCaseA' TestCase, 'Success' Result
INTO expected;

EXEC tSQLt.AssertEqualsTable 'expected', 'actual';
END;
GO

CREATE PROC AssertObjectExistsTests.test_AssertObjectExists_fails_when_object_exists_but_wrong_type
AS
BEGIN
EXEC('CREATE SCHEMA schemaA');
EXEC('CREATE VIEW schemaA.myView AS SELECT 1 AS col;');

DECLARE @Command NVARCHAR(MAX);
SET @Command = 'EXEC tSQLt.AssertObjectExists ''schemaA.myView'', '''', ''USER_TABLE''';
EXEC tSQLt_testutil.assertFailCalled @Command, 'AssertObjectExists did not call Fail when object type was incorrect';
END;
GO

CREATE PROC AssertObjectExistsTests.test_AssertObjectExists_error_message_includes_expected_and_actual_type
AS
BEGIN
EXEC('CREATE SCHEMA schemaA');
EXEC('CREATE VIEW schemaA.myView AS SELECT 1 AS col;');

DECLARE @Command NVARCHAR(MAX);
DECLARE @ActualMessage NVARCHAR(MAX);

BEGIN TRY
EXEC tSQLt.AssertObjectExists 'schemaA.myView', '', 'USER_TABLE';
END TRY
BEGIN CATCH
SET @ActualMessage = ERROR_MESSAGE();
END CATCH;

IF @ActualMessage NOT LIKE '%schemaA.myView%exists but is not of type%USER_TABLE%'
BEGIN
EXEC tSQLt.Fail 'Error message did not contain expected information. Actual: ', @ActualMessage;
END;

IF @ActualMessage NOT LIKE '%found type:%VIEW%'
BEGIN
EXEC tSQLt.Fail 'Error message did not contain actual type information. Actual: ', @ActualMessage;
END;
END;
GO

CREATE PROC AssertObjectExistsTests.test_AssertObjectExists_works_with_view_type
AS
BEGIN
DECLARE @ErrorRaised INT; SET @ErrorRaised = 0;

EXEC('CREATE SCHEMA MyTestClass;');
EXEC('CREATE VIEW MyTestClass.myView AS SELECT 1 AS col;');
EXEC('CREATE PROC MyTestClass.TestCaseA AS EXEC tSQLt.AssertObjectExists ''MyTestClass.myView'', '''', ''VIEW'';');

BEGIN TRY
EXEC tSQLt.Run 'MyTestClass.TestCaseA';
END TRY
BEGIN CATCH
SET @ErrorRaised = 1;
END CATCH
SELECT Class, TestCase, Result
INTO actual
FROM tSQLt.TestResult;
SELECT 'MyTestClass' Class, 'TestCaseA' TestCase, 'Success' Result
INTO expected;

EXEC tSQLt.AssertEqualsTable 'expected', 'actual';
END;
GO

CREATE PROC AssertObjectExistsTests.test_AssertObjectExists_works_with_stored_procedure_type
AS
BEGIN
DECLARE @ErrorRaised INT; SET @ErrorRaised = 0;

EXEC('CREATE SCHEMA MyTestClass;');
EXEC('CREATE PROC MyTestClass.myProc AS SELECT 1;');
EXEC('CREATE PROC MyTestClass.TestCaseA AS EXEC tSQLt.AssertObjectExists ''MyTestClass.myProc'', '''', ''SQL_STORED_PROCEDURE'';');

BEGIN TRY
EXEC tSQLt.Run 'MyTestClass.TestCaseA';
END TRY
BEGIN CATCH
SET @ErrorRaised = 1;
END CATCH
SELECT Class, TestCase, Result
INTO actual
FROM tSQLt.TestResult;
SELECT 'MyTestClass' Class, 'TestCaseA' TestCase, 'Success' Result
INTO expected;

EXEC tSQLt.AssertEqualsTable 'expected', 'actual';
END;
GO

CREATE PROC AssertObjectExistsTests.test_AssertObjectExists_type_comparison_is_case_insensitive
AS
BEGIN
DECLARE @ErrorRaised INT; SET @ErrorRaised = 0;

EXEC('CREATE SCHEMA MyTestClass;');
EXEC('CREATE TABLE MyTestClass.tbl(i int);');
EXEC('CREATE PROC MyTestClass.TestCaseA AS EXEC tSQLt.AssertObjectExists ''MyTestClass.tbl'', '''', ''user_table'';');

BEGIN TRY
EXEC tSQLt.Run 'MyTestClass.TestCaseA';
END TRY
BEGIN CATCH
SET @ErrorRaised = 1;
END CATCH
SELECT Class, TestCase, Result
INTO actual
FROM tSQLt.TestResult;
SELECT 'MyTestClass' Class, 'TestCaseA' TestCase, 'Success' Result
INTO expected;

EXEC tSQLt.AssertEqualsTable 'expected', 'actual';
END;
GO

CREATE PROC AssertObjectExistsTests.test_AssertObjectExists_temp_table_with_correct_type
AS
BEGIN
DECLARE @ErrorRaised INT; SET @ErrorRaised = 0;

EXEC('CREATE SCHEMA MyTestClass;');
CREATE TABLE #TempTbl(i int);
EXEC('CREATE PROC MyTestClass.TestCaseA AS EXEC tSQLt.AssertObjectExists ''#TempTbl'', '''', ''USER_TABLE'';');

BEGIN TRY
EXEC tSQLt.Run 'MyTestClass.TestCaseA';
END TRY
BEGIN CATCH
SET @ErrorRaised = 1;
END CATCH
SELECT Class, TestCase, Result
INTO actual
FROM tSQLt.TestResult;
SELECT 'MyTestClass' Class, 'TestCaseA' TestCase, 'Success' Result
INTO expected;

EXEC tSQLt.AssertEqualsTable 'expected', 'actual';
END;
GO

CREATE PROC AssertObjectExistsTests.test_AssertObjectExists_fails_when_expecting_procedure_but_got_table
AS
BEGIN
EXEC('CREATE SCHEMA schemaA');
EXEC('CREATE TABLE schemaA.myTable(i int);');

DECLARE @Command NVARCHAR(MAX);
SET @Command = 'EXEC tSQLt.AssertObjectExists ''schemaA.myTable'', '''', ''SQL_STORED_PROCEDURE''';
EXEC tSQLt_testutil.assertFailCalled @Command, 'AssertObjectExists did not call Fail when expecting procedure but found table';
END;
GO