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.

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

Add a "log" file so there'll be an artifact even if the tests are ended early #466

Closed
plocket opened this issue Jan 5, 2022 · 3 comments · Fixed by #517
Closed

Add a "log" file so there'll be an artifact even if the tests are ended early #466

plocket opened this issue Jan 5, 2022 · 3 comments · Fixed by #517
Assignees
Labels
enhancement New feature or request

Comments

@plocket
Copy link
Collaborator

plocket commented Jan 5, 2022

[Conclusion: Just for v4. Add a "log.txt" file where each report entry is saved as it happens. Upload that as a GitHub artifact at the end.]

That way if they see something failed and want to stop, they'll have something, even if it's slightly more messy. What do folks think? [Do this automatically? Do this only when dev requests it? If the latter, we can't do this for setup and takedown.]

[Include setup and takedown in the logs.]

I wish we could record everything that's logged to the console as well as all our report messages, but I'm not sure we can. See other issues about cucumber's output.

Should we be as verbose as possible in these logs, even logging our own debugging stuff, or should we stick with just stuff that would go in reports?

@plocket plocket added the question Further information is requested label Jan 5, 2022
@plocket plocket changed the title Add a log so there'll be an artifact even if the tests are ended early? Add a "log" file so there'll be an artifact even if the tests are ended early? Feb 14, 2022
@plocket plocket changed the title Add a "log" file so there'll be an artifact even if the tests are ended early? Add a "log" file so there'll be an artifact even if the tests are ended early Feb 14, 2022
@plocket plocket added enhancement New feature or request and removed question Further information is requested labels Feb 14, 2022
@plocket
Copy link
Collaborator Author

plocket commented Feb 14, 2022

I say we stick with report items and talk about debug logs later.

@mcdonaldcarolyn
Copy link
Collaborator

@plocket plocket linked a pull request Feb 18, 2022 that will close this issue
plocket added a commit that referenced this issue Mar 2, 2022
Created log.txt and git hub artifact for reports. Closes #466.

* add log.txt for report messages

* create artifact for logs

* Update changelog

* Update our package's dependencies for v4 (#503)

I'm thinking this is just going to be for v4. Not bothering with this for v3 unless we absolutely have to since none of the vulnerabilities are severe. My current rationale is that the more work we do to maintain 3, the less work we can do getting v4 ready for release. Ready to hear opinions.

- Close #164, update cucumber to v7
- Prepare for v8 of cucumber because I won't remember it later
- Close #394, update puppeteer
- Update our version of node (and that of our action that we'll run for other people's libs). [Addresses #393 so we can use the suffolk npm org package.]
- Use `npm audit` to fix the remaining vulnerabilities (now 0)
- [Remove package.json as discussed in #489 to align our tests' behaviors with those of our users.]

* Update action.yml node to v17

* Update from cucumber v6 to v7. See details.

See https://github.com/cucumber/cucumber-js/blob/main/docs/migration.md#migrating-to-cucumber-js-7xx

Only use cucumber setDefaultTimeout globally and use a shim that replicates the fix in v8 that lets you do custom timeouts more easily so we can still give enough time for steps that may need more time.

Use all caps for statuses.

Test screenshot step.

Btw, the cucumber test output visually looks a bit different now - when a scenario passes, all the steps pass too.

Sorry about the little comment changes, etc. Tried to remove a lot of those incidental unrelated changes.

* Update puppeteer to latest (13). See details below.

- page.waitFor -> page.waitForTimeout and page.waitForSelector (Got deprication notice. See puppeteer/puppeteer#6214.)
- remove removeEventListener (we'd need to change it to removeListener anyway - v4.0.0 and see https://github.com/puppeteer/puppeteer/blob/main/docs/api.md#eventemitterremovelistenerevent-handler). For now we'll count on page close taking care of it, just in case removing it would prevent multiple-file-downloads.

* Update GitHub worflow node version, tweak changelog item order

* Fix npm audit vulnerabilities and update action.yml cucumber

* Pin the colors lib in action.yml

* Remove package-lock.json #489, use kiln v4 for users, CHANGELOG

* Fix custom timeout, remove duplicate report entry, as per review

* Allow a developer to wait as a first Step v4. #387. Add test. (#506)

Closes #387.

Also, generally adds safety measures for when page does not exist.

Very similar to PR #459, but moving the responsibility down to a spot that most functions make use of, meaning that it'll be applied to a lot more cases. They mostly won't need it, but it might still be worth being more comprehensive.

* Allow a developer to wait as a first Step v4. #387. Add test.

Will be able to close once we've added this as an establishing
step (in addition to it being a regular step).

Also, generally adds safety measures for when page does not exist.

* Add test

Co-authored-by: Bryce Willey <Bryce.Steven.Willey@gmail.com>

Co-authored-by: Bryce Willey <Bryce.Steven.Willey@gmail.com>

* add log to gitnore and cleanup console.logs and typos

* add empty string to file

Co-authored-by: plocket <52798256+plocket@users.noreply.github.com>
Co-authored-by: Bryce Willey <Bryce.Steven.Willey@gmail.com>
@plocket
Copy link
Collaborator Author

plocket commented Mar 10, 2022

Closed by #517!

@plocket plocket closed this as completed Mar 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants