Address comments, add generated common_versions.sh

Author: vanhalenar

test/bin/common_versions.sh

@@ -39,66 +39,37 @@ get_vrel_from_rhsm() {
     echo ""
 }
 
-# The current release minor version (e.g. '17' for '4.17') affects
-# the definition of previous and fake next versions.
 export MINOR_VERSION=20
 export PREVIOUS_MINOR_VERSION=$(( "${MINOR_VERSION}" - 1 ))
 export YMINUS2_MINOR_VERSION=$(( "${MINOR_VERSION}" - 2 ))
 export FAKE_NEXT_MINOR_VERSION=$(( "${MINOR_VERSION}" + 1 ))
 
-# For a main branch, the current release repository usually comes from
-# the OpenShift mirror site, either 'ocp-dev-preview' in the beginning of the
-# development cycle or 'ocp' when release candidates are built regularly.
-#
-# For a release branch, the current release repository should come from the
-# official 'rhocp' stream.
-CURRENT_RELEASE_REPO="" # "https://mirror.openshift.com/pub/openshift-v4/$(uname -m)/microshift/ocp/latest-4.20/el9/os"
-CURRENT_RELEASE_VERSION="" # "$(get_vrel_from_beta "${CURRENT_RELEASE_REPO}")"
+CURRENT_RELEASE_REPO=""
+CURRENT_RELEASE_VERSION=""
 export CURRENT_RELEASE_REPO
 export CURRENT_RELEASE_VERSION
 
-# The previous release repository value should either point to the OpenShift
-# mirror URL or the 'rhocp' repository name.
-#
-# For a main branch, the previous release repository may come from the
-# official 'rhocp' stream or the OpenShift mirror. It is necessary to use the
-# release candidate repository from the OpenShift mirror after a branch is
-# created, but the previous release has not been made public yet.
-#
-# For a release branch, the previous release repository should come from the
-# official 'rhocp' stream.
 PREVIOUS_RELEASE_REPO="https://mirror.openshift.com/pub/openshift-v4/$(uname -m)/microshift/ocp/latest-4.19/el9/os"
 PREVIOUS_RELEASE_VERSION="$(get_vrel_from_beta "${PREVIOUS_RELEASE_REPO}")"
 export PREVIOUS_RELEASE_REPO
 export PREVIOUS_RELEASE_VERSION
 
-# The y-2 release repository value should always contain the 'rhocp' repository name.
 YMINUS2_RELEASE_REPO="rhocp-4.18-for-rhel-9-$(uname -m)-rpms"
 YMINUS2_RELEASE_VERSION="$(get_vrel_from_rhsm "${YMINUS2_RELEASE_REPO}")"
 export YMINUS2_RELEASE_REPO
 export YMINUS2_RELEASE_VERSION
 
-# Define either a release version or the OpenShift mirror beta repository URL.
-# If the release version is defined, the repository should be deduced from the
-# CURRENT_RELEASE_REPO setting.
 RHOCP_MINOR_Y=""
-RHOCP_MINOR_Y_BETA="https://mirror.openshift.com/pub/openshift-v4/$(uname -m)/dependencies/rpms/4.20-el9-beta/"
+RHOCP_MINOR_Y_BETA="https://mirror.openshift.com/pub/openshift-v4/$(uname -m)/dependencies/rpms/4.20-el9-beta"
 export RHOCP_MINOR_Y
 export RHOCP_MINOR_Y_BETA
 
-# Define a release version and/or the OpenShift mirror beta repository URL.
-# If the release version is defined, the repository should be deduced from the
-# PREVIOUS_RELEASE_REPO setting.
-# Beta repository URL needs to be set for CentOS images as they don't have access to the RHOCP.
 RHOCP_MINOR_Y1=""
-RHOCP_MINOR_Y1_BETA="https://mirror.openshift.com/pub/openshift-v4/$(uname -m)/dependencies/rpms/4.19-el9-beta/"
+RHOCP_MINOR_Y1_BETA="https://mirror.openshift.com/pub/openshift-v4/$(uname -m)/dependencies/rpms/4.19-el9-beta"
 export RHOCP_MINOR_Y1
 export RHOCP_MINOR_Y1_BETA
 
-# Define a release version as it is not expected to use the OpenShift mirror
-# for the y-2 release.
 export RHOCP_MINOR_Y2=18
 
-# The version of Sonobuoy package used in CNCF tests.
-# See https://github.com/vmware-tanzu/sonobuoy/releases.
 export CNCF_SONOBUOY_VERSION=v0.57.3
+

test/bin/generate_common_versions.py

@@ -2,64 +2,85 @@
 """
 The generate_common_versions.py generates all variables for the common_versions.sh script and prints them to stdout.
 """
+
 import requests
 import subprocess
 import os
 import sys
 import argparse
+import logging
 
 ARCH = os.uname().machine
 
+# The version of Sonobuoy package used in CNCF tests.
+# See https://github.com/vmware-tanzu/sonobuoy/releases.
 CNCF_SONOBUOY_VERSION = "v0.57.3"
 
+logging.basicConfig(
+    level=logging.INFO,
+    format='%(levelname)s: %(message)s',
+    stream=sys.stderr
+)
+
 
 def get_candidate_repo_url(minor, dev_preview=False):
     """
-    :param minor: the minor version, e.g. 19 for 4.19
-    :param dev_preview: if True, returns the engineering candidate repo, otherwise returns the release candidate repo
+    Get the URL of the engineering or release candidate repository.
+
+    Args:
+        minor (int): The minor version, e.g., 19 for version 4.19.
+        dev_preview (bool): If True, return the engineering candidate repo URL;
+            otherwise, return the release candidate repo URL.
 
-    ``get_candidate_repo_url`` returns the URL of the EC/RC repository for the specified minor version.
+    Returns:
+        str: The URL of the candidate repository.
     """
     return f"https://mirror.openshift.com/pub/openshift-v4/{ARCH}/microshift/ocp{'-dev-preview' if dev_preview else ''}/latest-4.{minor}/el9/os"
 
 
-def get_dependencies_repo_url(minor, prev=None):
+def get_dependencies_repo_url(minor, steps_back=0):
     """
-    :param minor: the minor version, e.g. 19. for 4.19
-    :param prev: specifies how many previous minor versions to try if current is unavailable
+    Get the URL of the beta repository for the specified minor version.
 
-    ``get_dependencies_repo_url`` returns the URL of the beta repository for the specified
-    minor version. If the repo for the wanted version does not exist or it does not provide
-    the necessary packages, it looks for previous releases, for up to `prev` previous minors.
-    If `prev` is not specified, it only checks the current minor.
-    """
+    This function constructs and checks the beta repository URL for the given
+    minor version (e.g., 4.19). If the repository does not exist or does not
+    provide the required packages, it searches previous minor versions—up to
+    `steps_back` times—until a valid repository is found.
 
-    count = prev if prev is not None else 0
+    Args:
+        minor (int): The minor version, e.g., 19 for version 4.19.
+        steps_back (int, optional): How many previous minor versions to try
+            if the current version is unavailable. Defaults to 0.
 
-    print(f"Getting beta repository for 4.{minor}, max. {count} previous minors", file=sys.stderr)
+    Returns:
+        str or None: The URL of a valid beta repository, or None if none are found.
+    """
+    logging.info(f"Getting beta repository for 4.{minor}, max. {steps_back} previous minors")
 
-    for i in range(minor, minor-count-1, -1):
+    for i in range(minor, minor-steps_back-1, -1):
         url = f"https://mirror.openshift.com/pub/openshift-v4/{ARCH}/dependencies/rpms/4.{i}-el9-beta"
-        if mirror_exists(url) and provides_pkg(url, "cri-o"):
-            print(f"Beta repository found for 4.{i}", file=sys.stderr)
+        if mirror_exists(url) and repo_provides_pkg(url, "cri-o"):
+            logging.info(f"Beta repository found for 4.{i}")
             return url
-        print(f"Beta repository for 4.{i} not found{', retrying' if i>minor-count else ''}")
-
+        logging.info(f"Beta repository for 4.{i} not found{', trying older minor' if i>minor-steps_back else ''}")
     return None
 
 
-def provides_pkg(repo, pkg):
+def repo_provides_pkg(repo, pkg):
     """
-    :param repo: the repository to check
-    :param pkg: the package to look for
+    Check if the repository provides the specified package.
+
+    Args:
+        repo (str): The repository URL or name to check.
+        pkg (str): The name of the package to look for.
 
-    ``provides_pkg`` checks if the repository provides the package specified by `pkg`.
+    Returns:
+        bool: True if the package is available in the repository, False otherwise.
     """
     args = ['dnf', 'repoquery', pkg, '--queryformat', '%{version}-%{release}']
 
     if repo.startswith("https"):
-        temp = f"this,{repo}"
-        args += ['--disablerepo', '*', '--repofrompath', temp]
+        args += ['--disablerepo', '*', '--repofrompath', f"this,{repo}"]
     else:
         args += ['--repo', repo]
 
@@ -72,9 +93,13 @@ def provides_pkg(repo, pkg):
 
 def mirror_exists(repo_url):
     """
-    :param repo_url: the URL of a repository
+    Check if a URL points to a valid repository.
 
-    ``mirror_exists`` checks if a URL points to a valid repository.
+    Args:
+        repo_url (str): The URL of the repository to check.
+
+    Returns:
+        bool: True if the repository exists and is accessible, False otherwise.
     """
     url = repo_url + "/repodata/repomd.xml"
     r = requests.get(url)
@@ -86,56 +111,75 @@ def mirror_exists(repo_url):
 
 def get_subscription_repo_name_if_exists(minor):
     """
-    :param minor: the minor version, e.g. 19 for 4.19
+    Get the name of the subscription repository for the specified minor version.
+
+    If the repository provides the microshift package, return the repository name;
+    otherwise, return None.
 
-    ``get_subscription_repo_name_if_exists`` returns the name of the subscription repository
-    for the specified minor version if the repository provides the microshift package,
-    otherwise returns None.
+    Args:
+        minor (int): The minor version, e.g., 19 for 4.19.
+
+    Returns:
+        str or None: The name of the subscription repository, or None if not available.
     """
     repo = f"rhocp-4.{minor}-for-rhel-9-{ARCH}-rpms"
 
-    if provides_pkg(repo, "microshift"):
+    if repo_provides_pkg(repo, "microshift"):
         return repo
     else:
         return None
 
 
 def get_microshift_repo(minor):
     """
-    :param minor: the minor version, e.g. 19 for 4.19
+    Get the repository for the specified minor version.
 
-    ``get_microshift_repo`` returns the repository for the specified minor version.
-    It looks for the 'rhocp' stream, release candidate and engineering candidate,
-    in that order, and checks if they provide the microshift package. If none of
-    these repositories are available, returns empty string.
-    """
+    This function searches for a repository that provides the microshift package
+    for the given minor version. It checks the 'rhocp' stream, then release
+    candidate (RC), and finally engineering candidate (EC) repositories—in that
+    order. If none are available, it returns an empty string.
+
+    Args:
+        minor (int): The minor version, e.g., 19 for 4.19.
 
+    Returns:
+        str: The repository name or URL if found, otherwise an empty string.
+    """
     repo = get_subscription_repo_name_if_exists(minor)
     if repo is not None:
-        print(f"Found subscription repository for 4.{minor}", file=sys.stderr)
+        logging.info(f"Found subscription repository for 4.{minor}")
         return repo
 
     rc = get_candidate_repo_url(minor, dev_preview=False)
-    if mirror_exists(rc) and provides_pkg(rc, "microshift"):
-        print(f"Found release candidate for 4.{minor}", file=sys.stderr)
+    if mirror_exists(rc) and repo_provides_pkg(rc, "microshift"):
+        logging.info(f"Found release candidate for 4.{minor}")
         return rc
 
     ec = get_candidate_repo_url(minor, dev_preview=True)
-    if mirror_exists(ec) and provides_pkg(ec, "microshift"):
-        print(f"Found engineering candidate for 4.{minor}", file=sys.stderr)
+    if mirror_exists(ec) and repo_provides_pkg(ec, "microshift"):
+        logging.info(f"Found engineering candidate for 4.{minor}")
         return ec
 
-    print(f"No repository found for 4.{minor}", file=sys.stderr)
+    logging.info(f"No repository found for 4.{minor}")
     return ""
 
 
 def get_release_version_string(repo, var_name):
     """
-    :param repo: the name or the URL of the repository
+    Get a Bash string calling the appropriate `get_vrel_from_*` function.
+
+    This function returns a string suitable for use as a Bash variable assignment,
+    calling either `get_vrel_from_rhsm` or `get_vrel_from_beta` depending on whether
+    the `repo` parameter is a repository name or a URL. If `repo` is neither,
+    it returns an empty string.
 
-    ``get_release_version_string`` returns a string to be used as a bash variable,
-    with a call to the right function depending on whether the `repo` param
-    is a URL or not. if neither, returns empty double quotes.
+    Args:
+        repo (str): The name or URL of the repository.
+        var_name (str): The name of the Bash variable to use in the command.
+
+    Returns:
+        str: A Bash command string using the appropriate `get_vrel_from_*` function,
+        or an empty string if the input is invalid.
     """
     if repo.startswith("rhocp"):
         return f'$(get_vrel_from_rhsm "${{{var_name}}}")'
@@ -153,43 +197,91 @@ def get_release_version_string(repo, var_name):
 minor_version = args.minor
 previous_minor_version = minor_version - 1
 yminus2_minor_version = minor_version - 2
-fake_next_minor_version = minor_version + 1
 
 # The current release repository comes from the 'rhocp' stream for release
 # branches, or the OpenShift mirror if only a RC or EC is available. It can
 # be empty, if no candidate for the current minor has been built yet.
+logging.info("Getting CURRENT_RELEASE_REPO")
 current_release_repo = get_microshift_repo(minor_version)
 current_release_version = get_release_version_string(current_release_repo, "CURRENT_RELEASE_REPO")
 
 # The previous release repository value should either point to the OpenShift
 # mirror URL or the 'rhocp' repository name.
+logging.info("Getting PREVIOUS_RELEASE_REPO")
 previous_release_repo = get_microshift_repo(previous_minor_version)
 previous_release_version = get_release_version_string(previous_release_repo, "PREVIOUS_RELEASE_REPO")
 
 # The y-2 release repository value should either point to the OpenShift
 # mirror URL or the 'rhocp' repository name. It should always come from
 # the 'rhocp' stream.
+logging.info("Getting YMINUS2_RELEASE_REPO")
 yminus2_release_repo = get_microshift_repo(yminus2_minor_version)
 yminus2_release_version = get_release_version_string(yminus2_release_repo, "YMINUS2_RELEASE_REPO")
 
 # The 'rhocp_minor_y' variable should be the minor version number, if the
 # current release is available through the 'rhocp' stream, otherwise empty.
-rhocp_minor_y = minor_version if get_subscription_repo_name_if_exists(minor_version) is not None else '""'
+rhocp_minor_y = minor_version if repo_provides_pkg(f"rhocp-4.{minor_version}-for-rhel-9-{ARCH}-rpms", "cri-o") else '""'
 
 # The beta repository, containing dependencies, should point to the
-# OpenShift mirror URL. If the repository for current minor is not
+# OpenShift mirror URL. If the mirror for current minor is not
 # available yet, it should point to an older release.
+logging.info("Getting RHOCP_MINOR_Y_BETA")
 rhocp_minor_y_beta = get_dependencies_repo_url(minor_version, 3)
 
-# The 'rhocp_minor_y1' should always be the y-1 minor version number.
-# The repository for y-1 release should always exist.
-rhocp_minor_y1 = previous_minor_version
+# The 'rhocp_minor_y' variable should be the previous minor version number, if 
+# the previous release is available through the 'rhocp' stream, otherwise empty.
+rhocp_minor_y1 = previous_minor_version if repo_provides_pkg(f"rhocp-4.{previous_minor_version}-for-rhel-9-{ARCH}-rpms", "cri-o") else '""'
+
+# The beta repository, containing dependencies, should point to the
+# OpenShift mirror URL. The mirror for previous release should always
+# be available.
+logging.info("Getting RHOCP_MINOR_Y1_BETA")
 rhocp_minor_y1_beta = get_dependencies_repo_url(previous_minor_version)
 
 # The 'rhocp_minor_y2' should always be the y-2 minor version number.
 rhocp_minor_y2 = yminus2_minor_version
 
-output = f"""
+output = f"""#!/bin/bash
+set -euo pipefail
+
+if [[ "${{BASH_SOURCE[0]}}" == "${{0}}" ]]; then
+    echo "This script must be sourced, not executed."
+    exit 1
+fi
+
+get_vrel_from_beta() {{
+    local -r beta_repo="$1"
+    local -r beta_vrel=$(\\
+        dnf repoquery microshift \\
+            --quiet \\
+            --queryformat '%{{version}}-%{{release}}' \\
+            --disablerepo '*' \\
+            --repofrompath "this,${{beta_repo}}" \\
+            --latest-limit 1 2>/dev/null \\
+        )
+    if [ -n "${{beta_vrel}}" ]; then
+        echo "${{beta_vrel}}"
+        return
+    fi
+    echo ""
+}}
+
+get_vrel_from_rhsm() {{
+    local -r rhsm_repo="$1"
+    local -r rhsm_vrel=$(\\
+        dnf repoquery microshift \\
+            --quiet \\
+            --queryformat '%{{version}}-%{{release}}' \\
+            --repo "${{rhsm_repo}}" \\
+            --latest-limit 1 2>/dev/null \\
+        )
+    if [ -n "${{rhsm_vrel}}" ]; then
+        echo "${{rhsm_vrel}}"
+        return
+    fi
+    echo ""
+}}
+
 export MINOR_VERSION={minor_version}
 export PREVIOUS_MINOR_VERSION=$(( "${{MINOR_VERSION}}" - 1 ))
 export YMINUS2_MINOR_VERSION=$(( "${{MINOR_VERSION}}" - 2 ))