Activity Report Stepper cucumber tests #53

kryswisnaskas · 2020-10-23T00:42:09Z

Description of change
This PR adds tests for the Activity Report Stepper. To enable tests of the stepper, the auth is bypassed by setting a cookie containing a secret user id during the headless puppeteer tests.

How to test

Create two cucumber environment variables based on the .env.example.
Testing locally, run yarn deps and then yarn start:local
Then yarn cucumber
A report will be created in reports . This can be seen on the artifacts tab
Screenshots taken during the tests runs can also be seen on the artifacts tab
The online link can also be accessed to view the output

Issue(s)

Dev Chore/Task: Implement Cucumber tests for the basic stepper in the Activity Report HHS/Head-Start-TTADP#91

Checklist

Meets issue criteria
Code tested
[ n/a ] Meets accessibility standards (WCAG 2.1 Levels A, AA)
Documentation updated
- API methods
- Boundary and Data Flow Diagrams
- Architectural Decision Records written for major infrastructure decisions with the Nygard template
- OSCAL templates completed when security controls are implemented or modified

…into kw-cucumber-js

…art-TTADP into kw-cucumber-test-js

…into kw-cucumber-test-js

…ad-Start-TTADP into kw-cucumber-test-js

jasalisbury

I like how the tests scenarios flow in a understandable way! Have a few questions, nothing major.

jasalisbury · 2020-10-26T14:50:27Z

src/middleware/authMiddleware.js

@@ -20,8 +20,13 @@ export const hsesAuth = new ClientOAuth2({
 * @param {*} res - response
 */
 export function login(req, res) {
-  const uri = hsesAuth.code.getUri();
-  res.redirect(uri);
+  if (req.headers.cookie && req.headers.cookie === `CUCUMBER_USER=${process.env.CUCUMBER_USER}`) {


Do we want to guard this with a feature flag so we can make sure it isn't used production?

The CUCUMBER_USER is a secret var, but I will add an extra check whether we are in production

jasalisbury · 2020-10-26T14:53:46Z

cucumber/features/steps/activityReportStepperSteps.js

+Then('the {string} button is disabled', async (string) => {
+  const page = scope.context.currentPage;
+  const buttonOneSelector = 'button[disabled]';
+  // const buttonOne = await select(page).getElement('button:contains("Previous")');


Can remove some dead code

cucumber/features/steps/activityReportStepperSteps.js

jasalisbury · 2020-10-26T15:11:49Z

docs/adr/0010-bdd-testing.md

+
+## Context
+
+Behavior-driven development (BDD) allows for a broader team to collaborate on software development. The business stakeholders have insight into how well the software meets the requirements. Through automated tests they have a way to validate the functionality in a user friendly way. Cucumber, and it particular cucumber-js was selected as the tool of choice to accomplish this. To go along with cucumber-js, puppeteer as well as selenium webdriver were looked at to provide a full solution for BDD testing.


Cucumber, and it particular cucumber-js was selected as the tool of choice to accomplish this

Feels like this should be in the Decision section and is missing the selection of puppeteer.

Good point. The idea was to present why we chose Puppeteer, since it was compared to some extent with the selenium webdriver. I didn't look at alternatives to Cucumber itself. I did reorganize the sections though to hopefully make it clearer. Hope it makes more sense now.

jasalisbury · 2020-10-26T15:11:51Z

docs/adr/0010-bdd-testing.md

+
+## Decision
+
+Puppeteer as well as selenium webdriver provide a way to run automated browser tests. Both of these are popular tools to enable browser automation. Puppeteer offers more control over Chromium based browsers, very fast, headless by default, run modej, and it can take screenshots of the pages, both in an image and PDF formats. Additionally, it measures rendering and load times by Chrome Performance Analysis tool and it is easier to set up than selenium webdriver. The drawback to using Puppeteer is it's lack of full cross-browser support, which is offered by the selenium webdriver, since Puppeteer is specialized for Chromium.


This paragraph feels like it should be in the context section. Also this talks about Puppeteer and Selenium but not cucumber.

Same as above.

jasalisbury · 2020-10-26T15:12:13Z

docs/adr/0010-bdd-testing.md

+
+## Context
+
+Behavior-driven development (BDD) allows for a broader team to collaborate on software development. The business stakeholders have insight into how well the software meets the requirements. Through automated tests they have a way to validate the functionality in a user friendly way. Cucumber, and it particular cucumber-js was selected as the tool of choice to accomplish this. To go along with cucumber-js, puppeteer as well as selenium webdriver were looked at to provide a full solution for BDD testing.


Suggested change

Behavior-driven development (BDD) allows for a broader team to collaborate on software development. The business stakeholders have insight into how well the software meets the requirements. Through automated tests they have a way to validate the functionality in a user friendly way. Cucumber, and it particular cucumber-js was selected as the tool of choice to accomplish this. To go along with cucumber-js, puppeteer as well as selenium webdriver were looked at to provide a full solution for BDD testing.

Behavior-driven development (BDD) allows for a broader team to collaborate on software development. The business stakeholders have insight into how well the software meets the requirements. Through automated tests they have a way to validate the functionality in a user friendly way. Cucumber, and in particular cucumber-js was selected as the tool of choice to accomplish this. To go along with cucumber-js, puppeteer as well as selenium webdriver were looked at to provide a full solution for BDD testing.

jasalisbury · 2020-10-26T15:13:43Z

docs/adr/0010-bdd-testing.md

+
+## Decision
+
+Puppeteer as well as selenium webdriver provide a way to run automated browser tests. Both of these are popular tools to enable browser automation. Puppeteer offers more control over Chromium based browsers, very fast, headless by default, run modej, and it can take screenshots of the pages, both in an image and PDF formats. Additionally, it measures rendering and load times by Chrome Performance Analysis tool and it is easier to set up than selenium webdriver. The drawback to using Puppeteer is it's lack of full cross-browser support, which is offered by the selenium webdriver, since Puppeteer is specialized for Chromium.


Puppeteer offers more control over Chromium based browsers, very fast, headless by default, run modej, and it can take screenshots of the pages, both in an image and PDF formats.

Should it be run mode or run model? Not sure what you are trying to say there.

Thanks. It's run mode. I'll update

…ad-Start-TTADP into kw-cucumber-test-js

jasalisbury

Looks good!

rahearn

Nothing to change right now, but I had some feedback for future cucumber tests and steps.

rahearn · 2020-10-27T14:21:32Z

cucumber/features/activityReportStepper.feature

@@ -0,0 +1,28 @@
+Feature: Activity Report Stepper


The format of these steps is perfect. Good job

rahearn · 2020-10-27T14:23:19Z

cucumber/features/homePage.feature

+    # Scenario: Login is redirected to HSES
+    #     Given the home page of tta-smarthub
+    #     When pressing login
+    #     Then we should see "Head Start Enterprise System" page


I'd prefer this test was deleted instead of being commented out. Please do that when the stepper steps are removed.

rahearn · 2020-10-27T14:25:35Z

cucumber/features/steps/activityReportStepperSteps.js

+
+Then('I moved past the {string} step', async (string) => {
+  const page = scope.context.currentPage;
+  assert.equal(string, 'Activity Summary');


This line will lock down this step to only work with "Activity Summary". If that's desired, we should hard-code that in the test definition instead of using the parameter. If we want it to work with other strings then this line should be removed.

I also think a lot of these steps could be combined down to a single "Then I am on the {string} step". It would result in slightly worse readability in the feature file, but I think that is worth reducing duplicated code here. Another option is extracting the test steps into a function and calling that from each version of the step, or getting creative with regexes to match more versions of the feature file to a single step definition.

No need to change these steps at this time though.

rahearn · 2020-10-27T14:51:17Z

cucumber/features/steps/homePageSteps.js

+  await page.waitForSelector(selector);
+  const value = await page.$eval(selector, (el) => el.textContent);
+
+  assert.equal(value, string);


For the next time someone tries to use this step: this test should try to find a link by the text and then assert that it found anything. Or the name should be updated to pass in the href or other way to select more general links than only the activity-reports link.

Activity Report Stepper cucumber tests (#53)

kryswisnaskas added 30 commits October 8, 2020 09:55

Test drive cucumber

ce995b9

Merge branch 'main' of https://github.com/adhocteam/Head-Start-TTADP …

f3fec08

…into kw-cucumber-js

Test drive cucumber

b2154dc

Test drive cucumber

0f7e27f

Test drive cucumber

5e4536d

Test drive cucumber

516a695

Test drive cucumber

14226c7

Test drive cucumber

1f29240

Test drive cucumber

023ddf1

Test drive cucumber

4715975

Test drive cucumber

b0a4e12

Test drive cucumber

3b0686e

Test drive cucumber

0e74548

Test drive cucumber

0e40aaa

Test drive cucumber

2f567fb

Consolidated steps

3ef375b

Enable cucumber testing by env

a476b96

Enable cucumber testing by env

016943b

Enable cucumber testing by env

6bfa089

Enable cucumber testing by env

decab5e

Enable cucumber testing by env

1990ac2

Enable cucumber testing by env

b73f0ca

Enable cucumber testing by env

c9c24ac

Enable cucumber testing by env

2b34469

Enable cucumber testing by env

498831a

Enable cucumber testing by env

f89bbff

Enable cucumber testing by env

75013f0

Enable cucumber testing by env

85aa888

Debug config.yml

cacaf5c

Debug cucumber start

72d38cb

kryswisnaskas added 13 commits October 15, 2020 10:26

Debug cucumber start

998174e

Merge branch 'kw-cucumber-js' of https://github.com/adhocteam/Head-St…

2774588

…art-TTADP into kw-cucumber-test-js

Add tests for the activity report stepper

8e80cca

Merge branch 'main' of https://github.com/adhocteam/Head-Start-TTADP …

7e19ddc

…into kw-cucumber-test-js

Add auth bypass

47497a2

Remove debugging stmt

8f2cc8e

Add env variables to cucumber job

c8b0993

Set redirect variable for cucumber

844818c

Merge branch 'main' into kw-cucumber-test-js

071148d

Set redirect variable for cucumber

f2ba925

Merge branch 'kw-cucumber-test-js' of https://github.com/adhocteam/He…

8e26a95

…ad-Start-TTADP into kw-cucumber-test-js

Add screenshots, add tests

3cbc3b0

Merge branch 'main' into kw-cucumber-test-js

3fecdb9

kryswisnaskas requested review from jasalisbury and SarahJaine October 26, 2020 13:36

kryswisnaskas added 3 commits October 26, 2020 10:45

Add ADR for BDD testing

27cfca7

Merge branch 'kw-cucumber-test-js' of https://github.com/adhocteam/He…

6ee8e14

…ad-Start-TTADP into kw-cucumber-test-js

Update Readme

473da97

jasalisbury reviewed Oct 26, 2020

View reviewed changes

kryswisnaskas added 4 commits October 26, 2020 17:11

Adjust the ADR; remove dead code

5e4b0fd

Merge branch 'main' into kw-cucumber-test-js

58fa06e

Add a prod env check

df625f5

Merge branch 'kw-cucumber-test-js' of https://github.com/adhocteam/He…

647da9b

…ad-Start-TTADP into kw-cucumber-test-js

kryswisnaskas requested a review from rahearn October 27, 2020 14:07

jasalisbury approved these changes Oct 27, 2020

View reviewed changes

kryswisnaskas merged commit 2448e9d into main Oct 27, 2020

kryswisnaskas deleted the kw-cucumber-test-js branch October 27, 2020 14:52

kryswisnaskas mentioned this pull request Oct 27, 2020

Activity Report Stepper cucumber tests (#53) HHS/Head-Start-TTADP#115

Merged

3 tasks

rahearn reviewed Oct 27, 2020

View reviewed changes

rahearn added a commit that referenced this pull request Oct 30, 2020

Merge pull request #115 from adhocteam/main

1589bbc

Activity Report Stepper cucumber tests (#53)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Activity Report Stepper cucumber tests #53

Activity Report Stepper cucumber tests #53

kryswisnaskas commented Oct 23, 2020 •

edited

Loading

jasalisbury left a comment

jasalisbury Oct 26, 2020

kryswisnaskas Oct 26, 2020

jasalisbury Oct 26, 2020

jasalisbury Oct 26, 2020

kryswisnaskas Oct 26, 2020

jasalisbury Oct 26, 2020

kryswisnaskas Oct 26, 2020

jasalisbury Oct 26, 2020

jasalisbury Oct 26, 2020

kryswisnaskas Oct 26, 2020

jasalisbury left a comment

rahearn left a comment

rahearn Oct 27, 2020

rahearn Oct 27, 2020

rahearn Oct 27, 2020

rahearn Oct 27, 2020


		## Context

		Behavior-driven development (BDD) allows for a broader team to collaborate on software development. The business stakeholders have insight into how well the software meets the requirements. Through automated tests they have a way to validate the functionality in a user friendly way. Cucumber, and it particular cucumber-js was selected as the tool of choice to accomplish this. To go along with cucumber-js, puppeteer as well as selenium webdriver were looked at to provide a full solution for BDD testing.


		## Decision

		Puppeteer as well as selenium webdriver provide a way to run automated browser tests. Both of these are popular tools to enable browser automation. Puppeteer offers more control over Chromium based browsers, very fast, headless by default, run modej, and it can take screenshots of the pages, both in an image and PDF formats. Additionally, it measures rendering and load times by Chrome Performance Analysis tool and it is easier to set up than selenium webdriver. The drawback to using Puppeteer is it's lack of full cross-browser support, which is offered by the selenium webdriver, since Puppeteer is specialized for Chromium.

Activity Report Stepper cucumber tests #53

Activity Report Stepper cucumber tests #53

Conversation

kryswisnaskas commented Oct 23, 2020 • edited Loading

jasalisbury left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jasalisbury left a comment

Choose a reason for hiding this comment

rahearn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kryswisnaskas commented Oct 23, 2020 •

edited

Loading