Skip to content

Commit 9bfcc3f

Browse files
Added Smoke Test FAQ (#2765)
* Added Smoke Test FAQ Added Smoke Test in FAQ, also attached Smoke Test general instructions in separate file i.e. SmokeTesting.md * Final changes
1 parent a745653 commit 9bfcc3f

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

FAQ.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,24 @@ If you're making changes ensure you follow the contribution guidelines in
8585

8686
For more information, see the [PR testing documentation](Testing.md).
8787

88+
## What are smoke tests?
89+
90+
Smoke tests are quick and simple tests to verify that we 'built the right thing'. They can be found in the [buildAndPackage directory](https://github.com/adoptium/temurin-build/tree/master/test/functional/buildAndPackage)
91+
Smoke tests verify things like:
92+
93+
- the java -version output is correct
94+
- certain features are available in certain builds (checks for shenandoah GC or xxx)
95+
- the right set of modules are included
96+
etc
97+
98+
## How and where are smoke tests run?
99+
100+
They use the same mechanisms and automation used by the AQA test suite. This means they can be run on the commandline, or as part of a Jenkins job or in a Github workflow. For this repository, they are part of PR testing via the [build.yml](https://github.com/adoptium/temurin-build/blob/master/.github/workflows/build.yml#L151) workflow using the [run-aqa](https://github.com/adoptium/run-aqa) action.
101+
102+
They are also run as part of the Jenkins build pipelines (see the [runSmokeTests()](https://github.com/adoptium/ci-jenkins-pipelines/blob/master/pipelines/build/common/openjdk_build_pipeline.groovy#L264-L301) method in the openjdk_build_pipeline groovy script), triggered after the build is complete and before any AQA tests get run against the build. If smoke tests fail, it likely indicates we built the 'wrong thing' and there is no point running further testing until we resolve the build issues.
103+
104+
To run them on the command-line, one can follow the same general instructions for running any AQA test on the command line, with the additional step of exporting variables to indicate where to find test material (VENDOR_TEST_REPOS, VENDOR_TEST_BRANCHES, VENDOR_TEST_DIRS). See: [SmokeTesting.md](https://github.com/adoptium/temurin-build/blob/master/SmokeTesting.md)
105+
88106
## Which OS levels do we build on?
89107

90108
The operating systems/distributions which we build or are documented in the

0 commit comments

Comments
 (0)