rename pre-check to submission-validate

.github/workflows/build.yml

@@ -102,19 +102,19 @@ jobs:
           fi
           echo "insecure_skip_tls_verify=true" >> $GITHUB_OUTPUT
 
-  pre-check:
+  validate-submission:
     name: Extract and validate PR content
     runs-on: ubuntu-22.04
     needs: [setup]
 
     outputs:
-      pr-content-error-message: ${{ steps.pre-check.outputs.pr-content-error-message }}
-      owners-error-message: ${{ steps.pre-check.outputs.owners-error-message }}
-      pre-check-outcome: ${{ steps.pre-check.outcome }}
-      chart_entry_name: ${{ steps.pre-check.outputs.chart_entry_name }}
-      release_tag: ${{ steps.pre-check.outputs.release_tag }}
-      web_catalog_only: ${{ steps.pre-check.outputs.web_catalog_only }}
-      category: ${{ steps.pre-check.outputs.category }}
+      pr-content-error-message: ${{ steps.validate-submission.outputs.pr-content-error-message }}
+      owners-error-message: ${{ steps.validate-submission.outputs.owners-error-message }}
+      validate-submission-outcome: ${{ steps.validate-submission.outcome }}
+      chart_entry_name: ${{ steps.validate-submission.outputs.chart_entry_name }}
+      release_tag: ${{ steps.validate-submission.outputs.release_tag }}
+      web_catalog_only: ${{ steps.validate-submission.outputs.web_catalog_only }}
+      category: ${{ steps.validate-submission.outputs.category }}
 
     steps:
       - name: Checkout
@@ -143,11 +143,11 @@ jobs:
           cd ..
 
       - name: Extract PR information
-        id: pre-check
+        id: validate-submission
         env:
           BOT_TOKEN: ${{ secrets.BOT_TOKEN }}
         run: |
-          ./ve1/bin/pre-check \
+          ./ve1/bin/validate-submission \
             --api_url "${{ github.event.pull_request._links.self.href }}" \
             --output "$SUBMISSION_PATH" \
             --repository ${{ github.repository }} \
@@ -188,7 +188,7 @@ jobs:
   chart-verifier:
     name: Run chart-verifier
     runs-on: ubuntu-22.04
-    needs: [setup, pre-check]
+    needs: [setup, validate-submission]
 
     if: ${{ always() }}
 
@@ -258,7 +258,7 @@ jobs:
           skip_cache: true
           chart-verifier: "${{ needs.setup.outputs.verifier-action-image }}"
 
-      # TODO: check what needs to stay here vs what could go to pre-check
+      # TODO: check what needs to stay here vs what could go to validate-submission
       - name: determine verify requirements
         if: ${{ needs.setup.outputs.run_build == 'true' && ! contains(join(needs.*.result, ','), 'failure') }}
         id: verify_requires
@@ -352,8 +352,8 @@ jobs:
         if: ${{ needs.setup.outputs.run_build == 'true' && ! contains(join(needs.*.result, ','), 'failure') }}
         env:
           BOT_TOKEN: ${{ secrets.BOT_TOKEN }}
-          VENDOR_TYPE: ${{ needs.pre-check.outputs.category }}
-          WEB_CATALOG_ONLY: ${{ needs.pre-check.outputs.web_catalog_only }}
+          VENDOR_TYPE: ${{ needs.validate-submission.outputs.category }}
+          WEB_CATALOG_ONLY: ${{ needs.validate-submission.outputs.web_catalog_only }}
           REPORT_GENERATED: ${{ steps.verify_requires.outputs.report_needed }}
           GENERATED_REPORT_PATH: ${{ steps.run-verifier.outputs.report_file }}
           REPORT_SUMMARY_PATH: ${{ steps.run-verifier.outputs.report_info_file }}
@@ -389,7 +389,7 @@ jobs:
   # manage-gh-pr:
   #   name: Comment and merge PR
   #   runs-on: ubuntu-22.04
-  #   needs: [setup, pre-check, chart-verifier]
+  #   needs: [setup, validate-submission, chart-verifier]
 
   #   # outputs:
   #   # if: ${{ always() && contains(join(needs.*.result, ','), 'success') }}
@@ -400,13 +400,13 @@ jobs:
         if: ${{ always() && needs.setup.outputs.run_build == 'true' }}
         env:
           BOT_TOKEN: ${{ secrets.BOT_TOKEN }}
-          PR_CONTENT_ERROR_MESSAGE: ${{ needs.pre-check.outputs.pr-content-error-message }}
-          OWNERS_ERROR_MESSAGE: ${{ needs.pre-check.outputs.owners-error-message }}
+          PR_CONTENT_ERROR_MESSAGE: ${{ needs.validate-submission.outputs.pr-content-error-message }}
+          OWNERS_ERROR_MESSAGE: ${{ needs.validate-submission.outputs.owners-error-message }}
           COMMUNITY_MANUAL_REVIEW: ${{ steps.check_report.outputs.community_manual_review_required }}
           OC_INSTALL_RESULT: ${{ steps.install-oc.outcome }}
           VERIFIER_ERROR_MESSAGE: ${{ steps.check-verifier-result.outputs.verifier_error_message }}
         run: |
-          ve1/bin/pr-comment ${{ needs.pre-check.outputs.pre-check-outcome }} ${{ steps.run-verifier.outcome }} ${{ steps.check_report.conclusion }}
+          ve1/bin/pr-comment ${{ needs.validate-submission.outputs.validate-submission-outcome }} ${{ steps.run-verifier.outcome }} ${{ steps.check_report.conclusion }}
 
       # Note(komish): This step is a temporary fix for the metrics step in the next job
       # which expects the PR comment to exist at the specified filesystem location.
@@ -434,7 +434,7 @@ jobs:
             });
 
       - name: Add 'authorized-request' label to PR
-        if: ${{ always() && needs.pre-check.outputs.pre-check-outcome == 'success' && steps.run-verifier.outcome != 'failure' && needs.setup.outputs.run_build == 'true' }}
+        if: ${{ always() && needs.validate-submission.outputs.validate-submission-outcome == 'success' && steps.run-verifier.outcome != 'failure' && needs.setup.outputs.run_build == 'true' }}
         uses: actions/github-script@v7
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
@@ -481,7 +481,7 @@ jobs:
   release:
     name: Release Chart
     runs-on: ubuntu-22.04
-    needs: [setup, pre-check, chart-verifier]
+    needs: [setup, validate-submission, chart-verifier]
 
     steps:
       - name: Checkout
@@ -534,7 +534,7 @@ jobs:
           BOT_TOKEN: ${{ secrets.BOT_TOKEN }}
           REPORT_CONTENT: ${{ needs.chart-verifier.outputs.report_content }}
           REDHAT_TO_COMMUNITY: ${{ needs.chart-verifier.outputs.redhat_to_community }}
-          WEB_CATALOG_ONLY: ${{ needs.pre-check.outputs.web_catalog_only }}
+          WEB_CATALOG_ONLY: ${{ needs.validate-submission.outputs.web_catalog_only }}
           OCP_VERSION_RANGE: ${{ steps.get-ocp-range.outputs.ocp-version-range }}
         id: prepare-chart-release
         run: |
@@ -549,10 +549,10 @@ jobs:
       # Only the report file is always included.
       # The release tag format is <organization_name>-<chart_name>-<chart_version>
       - name: Create GitHub release
-        if: ${{ needs.pre-check.outputs.web_catalog_only == 'False' }}
+        if: ${{ needs.validate-submission.outputs.web_catalog_only == 'False' }}
         uses: softprops/action-gh-release@v1
         with:
-          tag_name: ${{ needs.pre-check.outputs.release_tag }}
+          tag_name: ${{ needs.validate-submission.outputs.release_tag }}
           files: |
               ${{ steps.prepare-chart-release.outputs.report_file }}
               ${{ steps.prepare-chart-release.outputs.public_key_file }}
@@ -565,8 +565,8 @@ jobs:
       - name: Update Helm repository index
         if: ${{ needs.setup.outputs.run_build == 'true' }}
         env:
-          CHART_ENTRY_NAME: ${{ needs.pre-check.outputs.chart_entry_name }}
-          WEB_CATALOG_ONLY: ${{ needs.pre-check.outputs.web_catalog_only }}
+          CHART_ENTRY_NAME: ${{ needs.validate-submission.outputs.chart_entry_name }}
+          WEB_CATALOG_ONLY: ${{ needs.validate-submission.outputs.web_catalog_only }}
         run: |
           # export WEB_CATALOG_ONLY=`jq .is_web_catalog_only ${{ github.env.SUBMISSION_PATH }}`
 

.github/workflows/python-test.yml

@@ -3,8 +3,8 @@ name: Python Test
 on:
   pull_request:
     paths:
-    # Only the precheck module currently provides unit tests
-    - 'scripts/src/precheck/*'
+    # Only the submission module currently provides unit tests
+    - 'scripts/src/submission/*'
 
 jobs:
   enforce:
@@ -26,4 +26,4 @@ jobs:
         cd ..
     - name: Run pytest
       run: |
-        ./ve1/bin/pytest scripts/src/precheck/
+        ./ve1/bin/pytest scripts/src/submission/

scripts/setup.cfg

@@ -34,7 +34,7 @@ console_scripts =
     chart-repo-manager = chartrepomanager.chartrepomanager:main
     chart-pr-review = chartprreview.chartprreview:main
     check-pr-content = checkprcontent.checkpr:main
-    pre-check = precheck.precheck:main
+    validate-submission = submission.validate:main
     pr-artifact = pullrequest.prartifact:main
     pr-comment = pullrequest.prepare_pr_comment:main
     sa-for-chart-testing = saforcharttesting.saforcharttesting:main

scripts/src/metrics/pushowners.py

@@ -23,7 +23,7 @@ def getFileContent(changed_file):
     try:
         owner_data = owners_file.get_owner_data_from_file(changed_file)
     except owners_file.OwnersFileError as e:
-        print("Exception loading OWNERS file: {e}")
+        print(f"Exception loading OWNERS file: {e}")
         return "", "", "", "", ""
 
     users_included = owners_file.get_users_included(owner_data)

scripts/src/precheck/serializer.py → scripts/src/submission/serializer.py

@@ -8,7 +8,7 @@
 import copy
 import json
 
-from precheck import submission
+from submission import submission
 
 
 class SubmissionEncoder(json.JSONEncoder):

scripts/src/precheck/serializer_test.py → scripts/src/submission/serializer_test.py

@@ -1,7 +1,6 @@
 import json
 
-from precheck import serializer
-from precheck import submission
+from submission import serializer, submission
 
 submission_json = """
 {

scripts/src/precheck/submission.py → scripts/src/submission/submission.py

@@ -491,9 +491,13 @@ def parse_web_catalog_only(self, repo_path=""):
 
             if not owners_web_catalog_only == report_web_catalog_only:
                 if owners_web_catalog_only:
-                    raise WebCatalogOnlyError("[ERROR] The web catalog distribution method is set for the chart but is not set in the report.")
+                    raise WebCatalogOnlyError(
+                        "[ERROR] The web catalog distribution method is set for the chart but is not set in the report."
+                    )
                 if report_web_catalog_only:
-                    raise WebCatalogOnlyError("[ERROR] Report indicates web catalog only but the distribution method set for the chart is not web catalog only.")
+                    raise WebCatalogOnlyError(
+                        "[ERROR] Report indicates web catalog only but the distribution method set for the chart is not web catalog only."
+                    )
 
         self.is_web_catalog_only = owners_web_catalog_only
 
@@ -527,7 +531,10 @@ def is_valid_web_catalog_only(self, repo_path=""):
             raise WebCatalogOnlyError(f"Failed to get report data at {report_path}")
 
         if verifier_report.get_package_digest(report_data) is None:
-            return False, "[ERROR] The web catalog distribution method requires a package digest in the report."
+            return (
+                False,
+                "[ERROR] The web catalog distribution method requires a package digest in the report.",
+            )
 
         return True, ""
 

scripts/src/precheck/submission_test.py → scripts/src/submission/submission_test.py

@@ -15,7 +15,7 @@
 
 from dataclasses import dataclass, field
 
-from precheck import submission
+from submission import submission
 
 # Define assets that are being reused accross tests
 expected_category = "partners"

scripts/src/precheck/precheck.py → scripts/src/submission/validate.py

@@ -1,8 +1,15 @@
+"""
+1. Pull all information related to the submitted chart from GitHub. That "comprend" the files that are added/modified by the PR, and information already present in the repo such as the ones present in the OWNERS file
+2. Validate the Submission: Check that the chart/version is not already present in the helm index, validate the web_catalog_only information are correct, validate that the version is semver compatible, validate that the required files are present, ...
+3. Save the submission object to a file.
+
+"""
+
 import argparse
 import json
 import sys
 
-from precheck import submission, serializer
+from submission import submission, serializer
 from tools import gitutils
 
 
@@ -109,7 +116,7 @@ def main():
         gitutils.add_output("owners-error-message", owners_error_msg)
 
     pr_content_error_msg = ""
-    if args.check_chart_submission: #TODO: why ?
+    if args.check_chart_submission:  # TODO: why ?
         pr_content_error_msg = craft_pr_content_error_msg(s, args.repository)
         if pr_content_error_msg:
             print(pr_content_error_msg)