magento/devdocs#: Expected exceptions #4148

atwixfirster · 2019-04-03T09:07:25Z

This PR is a:

New topic
Content update
Content fix or rewrite
Bug fix or improvement

Summary

When this pull request is merged, it will add information to "GraphQL functional testing" page how to cover negative scenarios with expected exceptions.

Additional information

List all affected URLs

https://devdocs.magento.com/guides/v2.3/graphql/functional-testing.html

Thank you!

whatsnew
Added section about exceptions to GraphQL functional testing.

1. Add information how to cover negative scenarios with expected exceptions to "GraphQL functional testing" Page: https://devdocs.magento.com/guides/v2.3/graphql/functional-testing.html

devops-devdocs · 2019-04-03T09:09:04Z

An admin must run tests on this PR before it can be merged.

guides/v2.3/graphql/functional-testing.md

rogyar · 2019-04-10T12:15:59Z

Hi @atwixfirster. Thank you for your collaboration. Please, consider making minor adjustments mentioned in the review.

keharper · 2019-04-10T13:42:44Z

I've got this, @shrielenee . This PR expands #4082

keharper · 2019-04-10T20:48:10Z

@atwixfirster please pull in the changes from this PR

#4082

keharper · 2019-04-10T20:52:31Z

guides/v2.3/graphql/functional-testing.md

+  - in the body of test
+  - in test function annotation
+
+#### Define exception message expectation in the body of test


Delete one of the #s. The previous heading was a H2, so this one should be a H3.

keharper · 2019-04-10T20:53:45Z

guides/v2.3/graphql/functional-testing.md

+    } 
+```
+
+#### Define expected exception message in test function annotation


Change this to a H3 as well

keharper · 2019-04-10T20:58:32Z

guides/v2.3/graphql/functional-testing.md

+    }
+```
+
+There is a list of functions which you can use to cover expected exceptions:  


Suggested change

There is a list of functions which you can use to cover expected exceptions:

Use the following functions to cover expected exceptions:

Suggested change
There is a list of functions which you can use to cover expected exceptions:
Use the following functions to cover expected exceptions:

done

keharper · 2019-04-10T20:59:19Z

guides/v2.3/graphql/functional-testing.md

+```
+
+There is a list of functions which you can use to cover expected exceptions:  
+- expectException


Wrap the functions with a text code block

Wrap the functions with a text code block

done

Thank you, @keharper 👍

Merge remote-tracking branch 'upstream/master' into expected-exceptions # Conflicts: # guides/v2.3/graphql/functional-testing.md

atwixfirster · 2019-04-11T06:18:17Z

@atwixfirster please pull in the changes from this PR

#4082

done

keharper · 2019-04-11T15:06:36Z

guides/v2.3/graphql/functional-testing.md

@@ -193,3 +193,128 @@ try {
 $registry->unregister('isSecureArea');
 $registry->register('isSecureArea', false);
 ```
+
+## Expected exceptions
+When it is necessary to cover negative test scenarios and ensure that testing elicits proper responses, define the expected exception message:


I suggest something like this:

Your functional tests should include events that cause exceptions. Since your tests expect an exception to occur, set up your tests so that they elicit the proper responses. You can define expected exception messages either in:

The body of the test

The test function annotation

implemented

keharper · 2019-04-11T15:07:52Z

guides/v2.3/graphql/functional-testing.md

+  - in the body of test
+  - in test function annotation
+
+### Define exception message expectation in the body of test


Suggested change

### Define exception message expectation in the body of test

### Exception messages in the body of a test

guides/v2.3/graphql/functional-testing.md

keharper · 2019-04-11T16:32:50Z

guides/v2.3/graphql/functional-testing.md

+```
+
+{:.bs-callout .bs-callout-info}
+Please note that the exception message expectation should be defined before invoking a logic that generates the exception.


Suggested change

Please note that the exception message expectation should be defined before invoking a logic that generates the exception.

Define the exception message before invoking logic that generates the exception.

implemented

keharper · 2019-04-11T16:36:12Z

guides/v2.3/graphql/functional-testing.md

+{:.bs-callout .bs-callout-info}
+Please note that the exception message expectation should be defined before invoking a logic that generates the exception.
+
+For example, if `customer A` wants to retrieve information about `customer B cart. In this situation, `customer A` will get an error - "`The current user cannot perform operations on cart "XXXXX`", where `XXXXX` - is an unique ID of `customer B` cart. See code below to understand how to cover this example with `expectExceptionMessage` function:


Suggested change

For example, if `customer A` wants to retrieve information about `customer B cart. In this situation, `customer A` will get an error - "`The current user cannot perform operations on cart "XXXXX`", where `XXXXX` - is an unique ID of `customer B` cart. See code below to understand how to cover this example with `expectExceptionMessage` function:

As an example, consider the case where `customer A` tries to retrieve information about `customer B`'s cart. In this situation, `customer A` will get an error:

"`The current user cannot perform operations on cart "XXXXX`"

where `XXXXX` - is an unique ID of `customer B`'s cart. The following shows how to cover this example with an `expectExceptionMessage` function:

implemented

keharper · 2019-04-11T17:09:09Z

guides/v2.3/graphql/functional-testing.md

+    } 
+```
+
+### Define expected exception message in test function annotation


Suggested change

### Define expected exception message in test function annotation

### Exception messages in the annotation of a test function

keharper · 2019-04-11T17:13:37Z

guides/v2.3/graphql/functional-testing.md

+     */
+```
+
+Example: a customer wants to retrieve information about his own cart but he provides incorrect cart ID.


Suggested change

Example: a customer wants to retrieve information about his own cart but he provides incorrect cart ID.

In the following query, a customer provides an incorrect cart ID while trying to retrieve information about his own cart.

keharper · 2019-04-11T17:17:02Z

guides/v2.3/graphql/functional-testing.md

+}
+```
+
+See the code below how to cover this example with `@expectExceptionMessage` annotation:


Suggested change

See the code below how to cover this example with `@expectExceptionMessage` annotation:

The `@expectExceptionMessage` annotation provides the text for the exception in this test.

Thank you very much for your review , @keharper !

keharper · 2019-04-11T19:55:34Z

I built this file locally and saw that some changes to the spacing need to be made. So I did that, made a few grammatical changes, and also added Atwix as the author, since more than half of the content was contributed by your company in the last couple of weeks.

keharper · 2019-04-11T17:54:37Z

guides/v2.3/graphql/functional-testing.md

+- The test function annotation
+
+### Exception messages in the body of a test
+The following examples show two ways how to define expected exception message through `expectExceptionMessage` function.


Suggested change

The following examples show two ways how to define expected exception message through `expectExceptionMessage` function.

The following examples show two ways to define an expected exception message with the `expectExceptionMessage` function.

keharper · 2019-04-11T20:02:10Z

running tests

ghost · 2019-04-11T20:28:57Z

Hi @atwixfirster, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

keharper · 2019-04-11T20:29:16Z

Thanks for your contribution @atwixfirster

dshevtsov · 2019-04-15T15:37:49Z

@keharper the PR contains two labels to indicate the type of changes: Technical and Major update. Please use only one and add whatsnew if needed.

dshevtsov · 2019-04-15T15:44:14Z

@keharper add labels to indicate the affected versions.

magento/devdocs#: Expected exceptions

d9d01c9

1. Add information how to cover negative scenarios with expected exceptions to "GraphQL functional testing" Page: https://devdocs.magento.com/guides/v2.3/graphql/functional-testing.html

magento-engcom-team added Partner: Atwix partners-contribution PR created by Magento partner labels Apr 3, 2019

rogyar suggested changes Apr 10, 2019

View reviewed changes

rogyar added Technical Updates to the code or processes that alter the technical content of the doc Major Update Significant original updates to existing content labels Apr 10, 2019

rogyar self-assigned this Apr 10, 2019

atwixfirster added 2 commits April 10, 2019 15:46

magento/devdocs#: Expected exceptions

0e5695b

magento/devdocs#: Expected exceptions

741cc37

keharper self-assigned this Apr 10, 2019

keharper reviewed Apr 10, 2019

View reviewed changes

magento/devdocs#: Expected exceptions

c9f11b9

Merge remote-tracking branch 'upstream/master' into expected-exceptions # Conflicts: # guides/v2.3/graphql/functional-testing.md

magento/devdocs#: Expected exceptions

bc7f321

rogyar approved these changes Apr 11, 2019

View reviewed changes

keharper suggested changes Apr 11, 2019

View reviewed changes

atwixfirster and others added 2 commits April 11, 2019 20:43

magento/devdocs#: Expected exceptions

fbc737a

Update functional-testing.md

007dcfd

Update functional-testing.md

b2b276f

keharper approved these changes Apr 11, 2019

View reviewed changes

Merge branch 'master' into expected-exceptions

c19ccb0

keharper merged commit 2b42ae5 into magento:master Apr 11, 2019

keharper added 2.3.x Magento 2.3 related changes and removed Technical Updates to the code or processes that alter the technical content of the doc labels Apr 15, 2019

	There is a list of functions which you can use to cover expected exceptions:
	Use the following functions to cover expected exceptions:

	### Define exception message expectation in the body of test
	### Exception messages in the body of a test

	Please note that the exception message expectation should be defined before invoking a logic that generates the exception.
	Define the exception message before invoking logic that generates the exception.

	### Define expected exception message in test function annotation
	### Exception messages in the annotation of a test function

	Example: a customer wants to retrieve information about his own cart but he provides incorrect cart ID.
	In the following query, a customer provides an incorrect cart ID while trying to retrieve information about his own cart.

	See the code below how to cover this example with `@expectExceptionMessage` annotation:
	The `@expectExceptionMessage` annotation provides the text for the exception in this test.

	The following examples show two ways how to define expected exception message through `expectExceptionMessage` function.
	The following examples show two ways to define an expected exception message with the `expectExceptionMessage` function.

magento/devdocs#: Expected exceptions #4148

magento/devdocs#: Expected exceptions #4148

Uh oh!

Conversation

atwixfirster commented Apr 3, 2019 • edited by keharper Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

This PR is a:

Summary

Additional information

Uh oh!

devops-devdocs commented Apr 3, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rogyar commented Apr 10, 2019

Uh oh!

keharper commented Apr 10, 2019

Uh oh!

keharper commented Apr 10, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

atwixfirster commented Apr 11, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

keharper commented Apr 11, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

keharper commented Apr 11, 2019

Uh oh!

ghost commented Apr 11, 2019

Uh oh!

atwixfirster commented Apr 3, 2019 •

edited by keharper

Loading