Skip to content

Conversation

camilamacedo86
Copy link
Collaborator

@camilamacedo86 camilamacedo86 commented Jun 2, 2021

Description

This PR address significant changes. After it gets merged audit will start to display in the index.html custom dashboards in HTML which are generated using as a source of data the results of the reports made to check all bundles of the index images and output in JSON format.

e.g.:

audit-tool dashboard deprecate-apis --file=/Users/camilamacedo/go/src/github.com/operator-framework/audit-1/testdata/reports/redhat_redhat_operator_index/bundles_registry.redhat.io_redhat_redhat_operator_index_v4.8_2021-06-02.json --output-path=/Users/camilamacedo/go/src/github.com/operator-framework/audit-1/testdata/reports/redhat_redhat_operator_index/dashboard

Also, we are here pushing some fixes, cleanups and improvements.

Details

  • add a new command to generate custom dashboards in HTML created by using the JSON files,
  • move bundles/channels/packages reports to be sub-command of the index (see the readme changes). Note that is also motivated by Can this be run as a step in openshift CI during the bundle install #31. The idea is to allow perform the same checks and reports per bundle and not only per index. Use audit-tool index [bundles/packages/channels] instead of audit-tool [bundles/packages/channels]
  • start to look for the kinds which were deprecated
  • cleanup columns reports based on feedbacks (see the bundles reports). Mainly we removed what is not bringing so much value such as the maintainer's name and links
  • upgrade to go 1.16
  • add new column info to know what are the bundles which are using custom scorecard test
  • re-gen all reports using 4.8 index images
  • add to the testdata new reports over bundles from 4.6,4.7 indexes images
  • add a new hack to generate the index.html
  • remove the backport reports in the testdata and into the hack. We will no longer need to re-gen them.

@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 2, 2021
@coveralls
Copy link

coveralls commented Jun 2, 2021

Pull Request Test Coverage Report for Build 942491371

  • 0 of 581 (0.0%) changed or added relevant lines in 11 files are covered.
  • 16 unchanged lines in 6 files lost coverage.
  • Overall coverage decreased (-0.3%) to 1.008%

Changes Missing Coverage Covered Lines Changed/Added Lines %
pkg/actions/run_validators.go 0 6 0.0%
pkg/reports/channels/data.go 0 8 0.0%
pkg/actions/get_bundle.go 0 14 0.0%
pkg/reports/bundles/data.go 0 24 0.0%
pkg/helpers.go 0 25 0.0%
pkg/reports/bundles/columns.go 0 26 0.0%
pkg/reports/packages/report.go 0 67 0.0%
pkg/reports/packages/data.go 0 68 0.0%
pkg/actions/run_scorecard.go 0 72 0.0%
pkg/removed_apis.go 0 121 0.0%
Files with Coverage Reduction New Missed Lines %
pkg/actions/get_bundle.go 1 0%
pkg/helpers.go 1 0%
pkg/reports/packages/data.go 1 0%
pkg/reports/bundles/data.go 2 13.95%
pkg/actions/run_scorecard.go 4 0%
pkg/reports/packages/report.go 7 0%
Totals Coverage Status
Change from base Build 849873353: -0.3%
Covered Lines: 18
Relevant Lines: 1786

💛 - Coveralls

@camilamacedo86 camilamacedo86 changed the title WIP: Deprecated apis WIP: rfes: significant changes and improvements (add deprecates apis dashboard) Jun 2, 2021
@camilamacedo86 camilamacedo86 changed the title WIP: rfes: significant changes and improvements (add deprecates apis dashboard) rfes: significant changes and improvements (add deprecates apis dashboard) Jun 2, 2021
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 2, 2021
@camilamacedo86 camilamacedo86 changed the title rfes: significant changes and improvements (add deprecates apis dashboard) WIP: rfes: significant changes and improvements (add deprecates apis dashboard) Jun 12, 2021
@openshift-ci openshift-ci bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Jun 12, 2021
@camilamacedo86 camilamacedo86 changed the title WIP: rfes: significant changes and improvements (add deprecates apis dashboard) Significant changes and improvements and adding custom dashboards Jun 16, 2021
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 16, 2021
@camilamacedo86 camilamacedo86 changed the title Significant changes and improvements and adding custom dashboards Significant changes and improvements + adding custom dashboards Jun 16, 2021
@camilamacedo86 camilamacedo86 changed the title Significant changes and improvements + adding custom dashboards Significant changes and improvements + adding custom dashboards for github pages Jun 16, 2021
**Description**

This PR address significant changes. After it gets merged audit will start to display in the index.html custom dashboards in HTML which are generated using as a source of data the results of the reports made to check all bundles of the index images and output in JSON format.

e.g.:

` audit-tool dashboard deprecate-apis --file=/Users/camilamacedo/go/src/github.com/operator-framework/audit-1/testdata/reports/redhat_redhat_operator_index/bundles_registry.redhat.io_redhat_redhat_operator_index_v4.8_2021-06-02.json --output-path=/Users/camilamacedo/go/src/github.com/operator-framework/audit-1/testdata/reports/redhat_redhat_operator_index/dashboard`

Also, we are here pushing some fixes, cleanups and improvements.

**Details**

- add a new command to generate custom dashboards in HTML created by using the JSON files,
- move bundles/channels/packages reports to be sub-command of the index (see the readme changes). Note that is also motivated by #31. The idea is to allow perform the same checks and reports per bundle and not only per index. Use `audit-tool index [bundles/packages/channels]` instead of `audit-tool [bundles/packages/channels]`
- start to look for the kinds which were deprecated
- cleanup columns reports based on feedbacks (see the bundles reports). Mainly we removed what is not bringing so much value such as the maintainer's name and links
- upgrade to go 1.16
- add new column info to know what are the bundles which are using custom scorecard test
- re-gen all reports using 4.8 index images
- add to the testdata new reports over bundles from 4.6,4.7 indexes images
- add a new hack to generate the index.html
- remove the backport reports in the testdata and into the hack. We will no longer need to re-gen them.
@camilamacedo86 camilamacedo86 merged commit 30b4afd into operator-framework:main Jun 16, 2021
@camilamacedo86 camilamacedo86 deleted the deprecated-apis branch June 16, 2021 12:32
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.

3 participants