Add library to create test report manifest #270

zelinh · 2023-08-11T23:08:43Z

Description

Add groovy library to trigger report workflow to create test report manifest. Upload the generated test-report.yml to the S3 test results bucket.

Issues Resolved

Part of opensearch-project/opensearch-build#1274

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Zelin Hao <[email protected]>

codecov · 2023-08-11T23:29:33Z

Codecov Report

Merging #270 (1937e74) into main (9539179) will increase coverage by 0.55%.
Report is 4 commits behind head on main.
The diff coverage is 100.00%.

@@             Coverage Diff              @@
##               main     #270      +/-   ##
============================================
+ Coverage     86.63%   87.19%   +0.55%     
- Complexity       27       28       +1     
============================================
  Files            77       78       +1     
  Lines           202      203       +1     
  Branches         11       11              
============================================
+ Hits            175      177       +2     
  Misses           19       19              
+ Partials          8        7       -1

Files Changed	Coverage Δ
...ns/jobs/CreateUploadTestReportManifest_Jenkinsfile	`100.00% <100.00%> (ø)`

... and 1 file with indirect coverage changes

vars/createUploadTestReportManifest.groovy

tests/jenkins/TestCreateUploadTestReportManifest.groovy

rishabh6788 · 2023-08-14T22:39:57Z

vars/createUploadTestReportManifest.groovy

+                    "--test-run-id ${testID}",
+                    "--test-type ${testType}",
+                    "--base-path ${basePath}",
+                    "--component ${component}",


Since the component is an optional parameter, you can have a null check like here and then change it to
isNullOrEmpty(args.componentName.toString()) ? "" : "--component ${args.componentName}",

Good suggestion. Updating here. Thanks!

Signed-off-by: Zelin Hao <[email protected]>

zelinh · 2023-08-14T23:24:29Z

Just had a new commit to accommodate your suggestions. Please help take a look again. Thanks! @gaiksaya @rishabh6788

gaiksaya · 2023-08-14T23:32:33Z

tests/jenkins/TestCreateUploadTestReportManifest.groovy

+        super.setUp()
+        super.testPipeline("tests/jenkins/jobs/CreateUploadTestReportManifest_Jenkinsfile")
+        assertThat(getShellCommands('sh', 'report.sh'), hasItems('./report.sh tests/data/opensearch-1.3.0-test.yml --artifact-paths opensearch=https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/1.3.0/c3ff7a232d25403fa8cc14c97799c323/linux/x64/tar --test-run-id 1234 --test-type integ-test --base-path null/null/1.3.0/c3ff7a232d25403fa8cc14c97799c323/linux/x64/tar '))
+        assertThat(getShellCommands('sh', 'report.sh'), hasItems('./report.sh tests/data/opensearch-1.3.0-test.yml --artifact-paths opensearch=https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/1.3.0/c3ff7a232d25403fa8cc14c97799c323/linux/x64/tar opensearch-dashboards=https://ci.opensearch.org/ci/dbc/distribution-build-opensearch-dashboards/1.3.0/25b38c278cdd45efa583765d8ba76346/linux/x64/tar --test-run-id 1234 --test-type integ-test --base-path null/null/1.3.0/c3ff7a232d25403fa8cc14c97799c323/linux/x64/tar '))


This should have opensearch-dashboards test manifest. Also base path is going null here:
--base-path null/null/1.3.0/c3ff7a232d25403fa8cc14c97799c323/linux/x64/tar

Yeah. Updated here with a new OSD test manifest for 1.3.0.

gaiksaya · 2023-08-14T23:34:13Z

tests/jenkins/lib-testers/CreateUploadTestReportManifestLibTest.groovy

+        binding.setVariable('env', ['JOB_NAME': 'dummy_integ_test'])
+        binding.setVariable('ARTIFACT_BUCKET_NAME', 'DUMMY_BUCKET_NAME')
+        binding.setVariable('AWS_ACCOUNT_PUBLIC', 'DUMMY_AWS_ACCOUNT_PUBLIC')
+        binding.setVariable('ARTIFACT_BUCKET_NAME', 'DUMMY_ARTIFACT_BUCKET_NAME')
+        binding.setVariable('PUBLIC_ARTIFACT_URL', 'DUMMY_PUBLIC_ARTIFACT_URL')
+        binding.setVariable('env', ['BUILD_NUMBER': '487'])
+        binding.setVariable('STAGE_NAME', 'DUMMY_STAGE_NAME')


None of these variables are used in this library. Can you check and remove the unsed ones?
Thanks!

Yeah you are right! and also explains those null in the base-path. Updated in the latest commit.

vars/createUploadTestReportManifest.groovy

Signed-off-by: Zelin Hao <[email protected]>

gaiksaya · 2023-08-16T23:45:39Z

vars/createUploadTestReportManifest.groovy

+def call(Map args = [:]) {
+    lib = library(identifier: 'jenkins@main', retriever: legacySCM(scm))
+
+    if (!parameterCheck(args.testManifest, args.buildManifest, args.testRunID, args.testType)) return


What is this returning?

It's not returning anything. It's returned from this library and skips the rest of code below.

gaiksaya · 2023-08-17T21:48:01Z

vars/createUploadTestReportManifest.groovy

+def call(Map args = [:]) {
+    lib = library(identifier: 'jenkins@main', retriever: legacySCM(scm))
+
+    if (!parameterCheck(args.testManifest, args.buildManifest, args.testRunID, args.testType)) return


Suggested change

if (!parameterCheck(args.testManifest, args.buildManifest, args.testRunID, args.testType)) return

if (!parameterCheck(args.testManifest, args.buildManifest, args.testRunID, args.testType)) return null

Updated as suggested.

Signed-off-by: Zelin Hao <[email protected]>

gaiksaya

~~Please bump the version to next minor.~~

This is done.
Thanks!

Signed-off-by: Zelin Hao <[email protected]> (cherry picked from commit b5c7537) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Add library to create test report manifest

e9073be

Signed-off-by: Zelin Hao <[email protected]>

zelinh requested review from peterzhuamazon, prudhvigodithi, gaiksaya and rishabh6788 as code owners August 11, 2023 23:08

rishabh6788 reviewed Aug 14, 2023

View reviewed changes

vars/createUploadTestReportManifest.groovy Outdated Show resolved Hide resolved

rishabh6788 reviewed Aug 14, 2023

View reviewed changes

vars/createUploadTestReportManifest.groovy Outdated Show resolved Hide resolved

gaiksaya requested changes Aug 14, 2023

View reviewed changes

rishabh6788 reviewed Aug 14, 2023

View reviewed changes

Update the library based on review

ad5a340

Signed-off-by: Zelin Hao <[email protected]>

gaiksaya reviewed Aug 14, 2023

View reviewed changes

vars/createUploadTestReportManifest.groovy Show resolved Hide resolved

Fix tests

d8ac8a6

Signed-off-by: Zelin Hao <[email protected]>

zelinh force-pushed the jenkins_report branch 6 times, most recently from 889a941 to e45cfd9 Compare August 16, 2023 01:09

gaiksaya reviewed Aug 16, 2023

View reviewed changes

gaiksaya reviewed Aug 17, 2023

View reviewed changes

zelinh force-pushed the jenkins_report branch from e45cfd9 to 3268d6f Compare August 17, 2023 21:53

Add parameter checks

1937e74

Signed-off-by: Zelin Hao <[email protected]>

zelinh force-pushed the jenkins_report branch from 3268d6f to 1937e74 Compare August 17, 2023 22:28

gaiksaya approved these changes Aug 18, 2023

View reviewed changes

gaiksaya merged commit b5c7537 into opensearch-project:main Aug 18, 2023
7 checks passed

gaiksaya added the backport 5.x label Aug 18, 2023

opensearch-trigger-bot bot mentioned this pull request Aug 18, 2023

[Backport 5.x] Add library to create test report manifest #284

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add library to create test report manifest #270

Add library to create test report manifest #270

zelinh commented Aug 11, 2023

codecov bot commented Aug 11, 2023 •

edited

Loading

rishabh6788 Aug 14, 2023

zelinh Aug 14, 2023

zelinh commented Aug 14, 2023

gaiksaya Aug 14, 2023

zelinh Aug 14, 2023

gaiksaya Aug 14, 2023

zelinh Aug 14, 2023

gaiksaya Aug 16, 2023

zelinh Aug 17, 2023

gaiksaya Aug 17, 2023

zelinh Aug 17, 2023

gaiksaya left a comment •

edited

Loading

	if (!parameterCheck(args.testManifest, args.buildManifest, args.testRunID, args.testType)) return
	if (!parameterCheck(args.testManifest, args.buildManifest, args.testRunID, args.testType)) return null

Add library to create test report manifest #270

Add library to create test report manifest #270

Conversation

zelinh commented Aug 11, 2023

Description

Issues Resolved

codecov bot commented Aug 11, 2023 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zelinh commented Aug 14, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gaiksaya left a comment • edited Loading

Choose a reason for hiding this comment

codecov bot commented Aug 11, 2023 •

edited

Loading

gaiksaya left a comment •

edited

Loading