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

How should we organize Action artifacts? #429

Closed
plocket opened this issue Dec 12, 2021 · 5 comments
Closed

How should we organize Action artifacts? #429

plocket opened this issue Dec 12, 2021 · 5 comments
Labels
deep dive question Further information is requested

Comments

@plocket
Copy link
Collaborator

plocket commented Dec 12, 2021

Often if you want to download the errors, you also want the report, etc. Should we just output one artifact [folder] that's got everything else in it? If we do that, should we put each category inside that one folder its own folder? e.g. One folder for all screenshots. My instinct says 'no' for that last one.

Things we output now:

  1. Report
  2. Error screenshots
  3. Files from the download Step
  4. Screenshots from the screenshot Step

Things we still want to output:

  1. JSON vars from the new get JSON vars step
  2. JSON vars from errors
@plocket plocket added the question Further information is requested label Dec 12, 2021
@plocket plocket changed the title Should we put all the artifacts into one "all_artifacts" folder? How should we organize Action artifacts? Dec 29, 2021
@plocket
Copy link
Collaborator Author

plocket commented Dec 29, 2021

In that same spirit, the names of the files control the order in which they are listed in the folder. How do we want to order them? This is the info we have:

  1. The Scenario description
  2. The language the test was for (‘english’, ‘portugese’, etc.). Remember the developer can run the same tests in multiple languages if they so choose
  3. A timestamp (a bunch of digits)
  4. The category of file that was saved (‘screenshot’, ‘report’, ‘error’, or ‘download’)
  5. The tags for the test (‘@SomeTag’)

I haven't yet found a way to get the feature name.

Pros and cons of the ordering of those items? Should we exclude tags all together because they have the language in them? Should we exclude the language because it's in the tags (meaning we couldn't order these files by language)?

@plocket
Copy link
Collaborator Author

plocket commented Dec 30, 2021

Would also like to improve some of the artifact names. Ideas:

  • errors -> error_screens [though this makes the name longer...]
  • downloads -> downloaded_files? Not sure about this one. [Also longer...]

@plocket
Copy link
Collaborator Author

plocket commented Dec 31, 2021

Actually, should each scenario have its own folder? I'm not sure - right now it's very easy to bounce back and forth between error screenshots. Maybe scenario folders for user-created screenshots/files/artifacts and error stay in the outer folder?

@plocket
Copy link
Collaborator Author

plocket commented Feb 5, 2022

Maybe the error screenshots should be in both places. This is the idea proposed here, though the names are missing a bunch of pieces to avoid a mess and show the arrangement more clearly.

  • report.txt (whole report)
  • error-3pm-scenario 1 description-endingPgID.png
  • error-4pm-scenario 2 description-endingPgID.png
  • 3pm-endingPgID-scenario 1 description (folder)
    • report-endingPgID.txt (scenario only)
    • download-3pm-file-1-pgID.pdf
    • error-3pm-pgID.png (Same pic as "error-3pm-scenario 1 description.png". Same name seems dumb because it would have the scenario name in it too)
    • json-3pm-pgID.json
    • json-3pm-pgID.json
    • scenario 1 description.feature
    • screenshot-3pm-pgID.png
  • 4pm-endingPgID-scenario 2 description (folder)
    • report.txt (scenario only)
    • error-4pm-pgID.png (Same as scenario 1 error pic name rationale)
    • scenario 2 description.feature

"3pm" and "4pm" just indicates a timestamp. "PgID" could be question id or screen trigger var, whichever is available, or neither if none available. Not sure which is preferred.

@plocket
Copy link
Collaborator Author

plocket commented Feb 7, 2022

Strangely enough, closing in favor of #22, random input testing, where extensive discussion is happening about artifact directory structure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deep dive question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant