Skip to content
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

SFR-2078: Automate Different Publishing Sources #554

Open
wants to merge 4 commits into
base: development
Choose a base branch
from
+42 −0
Open

SFR-2078: Automate Different Publishing Sources #554

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8e327ed
SFR-2078: Automate Different Publishing Sources
ayan1229 Nov 5, 2024
b73eb3c
fix the changelog differences
ayan1229 Nov 5, 2024
6af8945
Merge branch 'development' into SFR-2078/autoamate_different_pub_sources
ayan1229 Nov 5, 2024
b3c6c29
revert appUrl on cucumber.js
ayan1229 Nov 8, 2024
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
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,19 @@

## [Prerelease]

- SFR-2078: autoamte and validate different publishing source collections

## [0.18.7]

- Fix header when banner is up

## [0.18.6]

- Add submit feedback error handling and new fields
- Fix docker file and playwright tests

## [0.18.5]

- Make NYPL footer sticky

## [0.18.4]
Expand Down
32 changes: 32 additions & 0 deletions playwright/features/pubSource.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
Feature: Specific Pub Sources
Copy link
Contributor

Choose a reason for hiding this comment

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

Im not quite sure I understand playwright feature testing. Is this the outline of test cases to be automated or does this actually these scenarios live on localhost?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is cucumber test scenarios. Basically all these steps are being tested and test steps are dynamically written in our test folder. Cucumber is used for easier documentation and quick test writing.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ok thanks! I understand.

These test scenarios are brittle and verbose.

I recommend considering breaking out the specific functionality to test:

  • Search functionality - ensure search results show up as expected given a very generic query
  • Reader functionality - ensure a specific file/type or source is readable.

Copy link
Contributor

Choose a reason for hiding this comment

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

Since we've added Playwright & Cucumber to the app, I've learned a lot more about how to structure Playwright tests, and the general best practice is to use a page object model. As an example, you can see how we are doing this in pjr: each page has its own folder that contains a spec file and a corresponding page file.

Also, I'd like to re-evaluate if we need to use Cucumber at all. Imo the layer of abstraction it provides doesn't provide any value and adds unnecessary complexity.

My recommendation would be to remove Cucumber and begin refactoring our tests to use the page object model.

Scenario: As a user I search for title "How safe is eating chicken" and open the title after search result is loaded
Given I go to the "home" page
When I select "title" from the category dropdown
And I fill in the "homepage search box" with "How safe is eating chicken?"
And I click the "search button"
And I click the "first read online button"
And the "e-reader settings button" should be displayed

Scenario: Chicken Farm
Given I go to the "home" page
When I select "title" from the category dropdown
And I fill in the "homepage search box" with "Chicken Farm"
And I click the "search button"
And I click the "first read online button"
And the "e-reader settings button" should be displayed

Scenario: Reading Fiction in Antebellum America
Given I go to the "home" page
When I select "title" from the category dropdown
And I fill in the "homepage search box" with "Reading Fiction in Antebellum America"
And I click the "search button"
And I click the "first read online button"
And the "e-reader settings button" should be displayed

Scenario: Climate Change and Agriculture
Given I go to the "home" page
When I select "title" from the category dropdown
And I fill in the "homepage search box" with "Climate Change and Agriculture"
And I click the "search button"
And I click the "first read online button"
And the "e-reader settings button" should be displayed
5 changes: 5 additions & 0 deletions playwright/support/mappings.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,4 +251,9 @@ export const inputs = {
petroleum: "petroleum",
"Robot Soccer": "Robot Soccer",
"Jane Austen": "Jane Austen",
"How safe is eating chicken?": "How safe is eating chicken?",
"Chicken Farm": "Chicken Farm",
"Reading Fiction in Antebellum America":
"Reading Fiction in Antebellum America",
"Climate Change and Agriculture": "Climate Change and Agriculture",
};
Loading