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

Updated testing documentation #13548

Merged
merged 2 commits into from
Sep 7, 2023

Conversation

marcusmoore
Copy link
Collaborator

Description

This PR simply adds some additional details to the testing documentation.

@marcusmoore marcusmoore requested a review from snipe as a code owner August 30, 2023 18:28
@what-the-diff
Copy link

what-the-diff bot commented Aug 30, 2023

PR Summary

  • Enhanced Test Running Instructions
    The user guide has been expanded with instructions on how to run tests using SQLite. This allows users to carry out tests in-memory for faster, more efficient operations.

  • MySQL Testing Instructions Introduced
    Our documentation now includes instructions for running tests using MySQL. This provides another option for users and expands the potential use-cases of our platform.

  • Parallel Test Execution Command Introduced
    A new feature has been added which allows users to run multiple tests simultaneously. This is a significant addition that could drastically reduce the time spent on testing procedures.

@snipe
Copy link
Owner

snipe commented Aug 31, 2023

I'm guessing I need to update the official docs tho? https://snipe-it.readme.io/docs/testing

Snipe-IT Documentation
Snipe-IT uses PHPUnit and Laravel Dusk as automated testing frameworks. We adhere to the Laravel way of doing things, which means our tests are broken down as described below. All tests are located in the tests directory of your local Snipe-IT installation.❗️If your tests break the CI build, or if y...

@marcusmoore
Copy link
Collaborator Author

Ah...I completely spaced on that. Yeah some updating is needed...

It seems like the docs included in the readme are more technical ("how to run the test suite") while the hosted docs express how to get started writing tests for the app.

I wonder if, in the hosted docs, we can let people know where our tests live, how to run them (which duplicates the info here...), and then point them to the Laravel docs on testing so we can get rid of the last half of that page?

@snipe snipe merged commit ec5238f into snipe:develop Sep 7, 2023
@marcusmoore marcusmoore deleted the update-testing-documentation branch September 7, 2023 16:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants