Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Added example for custom expectation-fail message in docs #486

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

Merged
jgebal merged 2 commits into from
Sep 29, 2017
Merged

Added example for custom expectation-fail message in docs #486

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4381f75
Added example for custom expectation-fail message
pesse Sep 28, 2017
c81bfca
Including suggested changes
pesse Sep 29, 2017
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
52 changes: 52 additions & 0 deletions docs/userguide/expectations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -471,3 +471,55 @@ end;
```
Since NULL is neither *true* nor *not true*, both expectations will report failure.

# Provide a custom error message
Copy link
Copy Markdown
Member

@jgebal jgebal Sep 29, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be consistent with the rest of document please change that to: Adding custom failure message

Expectations allow you to provide a custom error message as second argument:
````sql
ut.expect( a_actual {data-type}, 'custom error message if expectation fails' ).to_{matcher};
Copy link
Copy Markdown
Member

@jgebal jgebal Sep 29, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you replace the 'error message' with 'failure message' or just 'custom message'.
There is a difference between error and failure as we define errored test as a test procedure that raised an unhandled exception.

````
The message is added to the normal error message returned by the matcher.

This is not only useful to give more detailed and specific information about a test, but also if you have some kind of dynamic tests.

## Dynamic tests example
You have a bunch of tables and an archive-functionality for them and you want to test if the things you put into live-tables are removed from live-tables and present in archive-tables:

````sql
procedure test_data_existance( i_tableName varchar2 )
as
v_count_real integer;
v_count_archive integer;
begin

execute immediate 'select count(*) from ' || i_tablename || '' into v_count_real;
execute immediate 'select count(*) from ' || i_tablename || '_archive' into v_count_archive;

ut.expect( v_count_archive, 'error checking entry-count of ' || i_tablename || '_archive' ).to_( equal(1) );
ut.expect( v_count_real, 'error checking entry-count of ' || i_tablename ).to_( equal(0) );

end;

procedure test_archive_data
as
begin
-- Arrange
-- insert several data into real-tables here

-- Act
package_to_test.archive_data();

-- Assert
test_data_existance('TABLE_A');
test_data_existance('TABLE_B');
test_data_existance('TABLE_C');
test_data_existance('TABLE_D');
end;
````
A failed output will look like this:
````
Failures:

1) test_archive_data
"error checking entry-count of TABLE_A_archive"
Actual: 2 (number) was expected to equal: 1 (number)
at "UT_TEST_PACKAGE.TEST_DATA_EXISTANCE", line 12 ut.expect( v_count_archive, 'error checking entry-count of ' || i_tablename || '_archive' ).to_( equal(1) );
````