Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bitcoder/tutorial-spring
A Spring Boot basic tutorial
https://github.com/bitcoder/tutorial-spring
Last synced: about 1 month ago
JSON representation
A Spring Boot basic tutorial
- Host: GitHub
- URL: https://github.com/bitcoder/tutorial-spring
- Owner: bitcoder
- Created: 2024-04-04T14:47:04.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-04-09T15:34:51.000Z (9 months ago)
- Last Synced: 2024-04-09T20:53:51.841Z (9 months ago)
- Language: Java
- Size: 46.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Spring tutorial
This is a simple Spring Boot tutorial to showcase the CI flow:
- make local changes & push them
- CI tool runs build
- CI tool runs tests
- merge
This tutorial also pushes the results to Jira; the results are visible and its impacts can be tracked in Jira using a test management tool called Xray; this integration is optional but is shown as an example of how CI related results can be tracked elsewhere, including in the popular Jira issue tracker.
## Testing
This project contains unit and integration tests.
Unit tests are run using `surefire`, while integration tests can be run using `failsafe` maven plugin.
```bash
mvn test
```
```bash
mvn failsafe:integration-test
```
If we want to fail the build whenever running the IT, we can execute the maven target `failsafe:verify" after running the IT.
```bash
mvn failsafe:integration-test failsafe:verify
```
## CI
CI is implemented using GH actions, on a [worflow](./.github/workflows/maven.yml) that is triggered:
- on the main branch
- on PRs (pull-requests)
We can also trigger the workflow/build on demand, right from the [Actions page](actions/workflows/maven.yml).
## SonarCloud
This project is integrated with [SonarCloud](https://sonarcloud.io/project/overview?id=bitcoder_tutorial-spring), and PRs will have information about code quality.
## Jira (using Xray Test Management)
The testing results are pushed to [Xray](https://www.getxray.app/), a test management tool, in Jira; only the integration tests are pushed.
- test automation results will be tracked on a Test Plan issue
- automated test entities will be provisioned on Jira/Xray, if they don't exist yet
- (some) automated test are linked automatically to existing stories, if they're annotated with `@Requirement()` ([example](https://github.com/bitcoder/tutorial-spring/blob/2f0f43779c5f207409600997eb1d1320413e76b3/src/test/java/com/sergiofreire/xray/tutorials/springboot/IndexControllerMockedIT.java#L29)); that requires using the [xray-junit-extensions](https://github.com/Xray-App/xray-junit-extensions) dependency
To push the results to Jira, a maven plugin [xray-maven-plugin](https://github.com/Xray-App/xray-maven-plugin) is used; an alternative to that would be to use the GH action [xray-action](https://github.com/mikepenz/xray-action) instead.
## Contact
If you're having the TQS classes, you can reach out using my email account at sergio dot freire (you know the rest).
Any questions related with this code, please raise issues in this GitHub project. Feel free to contribute and submit PR's
You may also find me on [Twitter](https://twitter.com/darktelecom), where I write once in a while about testing (don't use that for TQS class related topics though).