Skip to content

Add docs about not running e2e testing m directly#2629

Merged
estroz merged 1 commit intooperator-framework:masterfrom
jberkhahn:e2e_main_entry
Mar 7, 2020
Merged

Add docs about not running e2e testing m directly#2629
estroz merged 1 commit intooperator-framework:masterfrom
jberkhahn:e2e_main_entry

Conversation

@jberkhahn
Copy link
Copy Markdown
Contributor

Description of the change:
Add docs text explaining why e2e operator tests must use the testing framework's MainEntry function.

Motivation for the change:
e2e tests that do not use the framework MainEntry function cause confusing errors when attempting to run your test, the source of which is not obvious. See #1908.

Closes #1908

@openshift-ci-robot openshift-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Mar 6, 2020
Copy link
Copy Markdown
Member

@estroz estroz left a comment

Choose a reason for hiding this comment

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

Formatting nit.

Comment thread doc/test-framework/writing-e2e-tests.md Outdated
Comment thread doc/test-framework/writing-e2e-tests.md Outdated
It is initialized by MainEntry and can be used anywhere in the tests.
It is initialized by the MainEntry function and can be used anywhere in the tests. As several
required arguments are initialized and added by MainEntry, do not attempt to run the testing M
directly.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
directly.

Comment thread doc/test-framework/writing-e2e-tests.md Outdated
@jberkhahn jberkhahn force-pushed the e2e_main_entry branch 2 times, most recently from 6bd1a9e to acad700 Compare March 7, 2020 00:04
Co-Authored-By: Eric Stroczynski <estroczy@redhat.com>
@jberkhahn jberkhahn requested a review from estroz March 7, 2020 00:07
Copy link
Copy Markdown
Member

@estroz estroz left a comment

Choose a reason for hiding this comment

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

/lgtm

Thanks for contributing!

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Mar 7, 2020
@estroz estroz merged commit 3530aaf into operator-framework:master Mar 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lgtm Indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

-namespacedMan issue in e2e testing

3 participants