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

Document LORIS automated testing #5859

Merged
merged 10 commits into from
Jan 13, 2020
Merged

Document LORIS automated testing #5859

merged 10 commits into from
Jan 13, 2020

Conversation

johnsaigle
Copy link
Contributor

Brief summary of changes

Adds a document that gives a high-level overview of our TravisCI pipeline.

This is intended as a general explainer of each of the tools we use. It will not include a list of each and every rule enforced by different tools nor provide example issues and solutions. Instead, links will be provided to the repositories of those tools as they'll be able to provide better detail than we can.

Content adapted from my presentation "How To Win The Love Of Travis".

Links to related tickets (GitHub, Redmine, ...)

@johnsaigle johnsaigle added the Category: Documentation PR or issue that aims to improve the documentation (test plans, wiki, comments...) label Dec 16, 2019
@johnsaigle johnsaigle marked this pull request as ready for review December 16, 2019 16:41
@christinerogers
Copy link
Contributor

This is great.
PHPCS and PHPMD, as well as the don't say simply tool, could/should be written up under another file (Automated PR Checks.md or Automated Tools?), given their role is more like code sniff/review processes than Automated Testing of the code.

@johnsaigle
Copy link
Contributor Author

I'll add a line for alex.js ("don't say simply" tool).

I'd rather keep phpcs and phpmd in this file. I'm looking at the document as being a place to send people when they're like "What is Travis, why is is failing" and this covers everything that Travis does. Whether something fails a test or is a style issue, both trigger the same kind and severity of problem from the perspective of someone trying to get a PR merged.

@johnsaigle
Copy link
Contributor Author

@christinerogers I added a line for alex.js in the main PR discussing that tool. #5789

Since it won't actually be enforced in our automated testing suite (i.e. Travis), I think it's more appropriate in the Style Guide document.

@johnsaigle
Copy link
Contributor Author

This may need updating after #5871

driusan
driusan previously requested changes Jan 6, 2020
docs/wiki/99 - Developers/Automated Testing.md Outdated Show resolved Hide resolved
docs/wiki/99 - Developers/Automated Testing.md Outdated Show resolved Hide resolved
docs/wiki/99 - Developers/Automated Testing.md Outdated Show resolved Hide resolved
docs/wiki/99 - Developers/Automated Testing.md Outdated Show resolved Hide resolved
@christinerogers
Copy link
Contributor

Last summer Alex Livadas wrote some text for developers in anticipation of these 99 - Developers pages.

@johnsaigle - any content from Alex's General Dev Troubleshooting Guide doc
or Unit Testing 101 that could be added?

cc @AlexandraLivadas

@johnsaigle
Copy link
Contributor Author

The general troubleshooting guide isn't really relevant here.

The other document you linked is deprecated as it's been converted into the UnitTestingGuide, which is already linked in the Unit Testing section of this document.

@johnsaigle johnsaigle dismissed driusan’s stale review January 7, 2020 21:11

suggested changes accepted

@kchatpar
Copy link

LGTM.

Copy link
Collaborator

@driusan driusan left a comment

Choose a reason for hiding this comment

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

LGTM

@driusan driusan merged commit de5440c into aces:master Jan 13, 2020
@johnsaigle johnsaigle deleted the 191216-AutomatedTestingDocument branch January 14, 2020 20:16
@ridz1208 ridz1208 added this to the 23.0.0 milestone Jan 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Documentation PR or issue that aims to improve the documentation (test plans, wiki, comments...)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Wiki] Explain the test suite for developers
6 participants