Fix PR Findings

Author: stephenking314

pushflatpakscript/docker.d/init_worker.sh

@@ -26,8 +26,18 @@ case $ENV in
     echo $REPO_TOKEN_BETA | base64 -d > $REPO_TOKEN_BETA_PATH
     echo $REPO_TOKEN_STABLE | base64 -d > $REPO_TOKEN_STABLE_PATH
 
-    if [[$COT_PRODUCT == 'thunderbird']]; then
-      test_var_set 'REPO_TOKEN_ESR'
+
+    if [ "$COT_PRODUCT" = thunderbird ]; then
+      # test_var_set 'REPO_TOKEN_RELEASE'
+      # must either have REPO_TOKEN_RELEASE or REPO_TOKEN_ESR defined
+      if [[ -z "$REPO_TOKEN_RELEASE" ]] && [[ -z "$REPO_TOKEN_ESR" ]]; then
+        echo "error: must have token defined for release or esr channel"
+        exit 1
+      fi
+
+      export REPO_TOKEN_RELEASE_PATH=$CONFIG_DIR/release_token.txt
+      echo $REPO_TOKEN_RELEASE | base64 -d > $REPO_TOKEN_RELEASE_PATH
+
       export REPO_TOKEN_ESR_PATH=$CONFIG_DIR/esr_token.txt
       echo $REPO_TOKEN_ESR | base64 -d > $REPO_TOKEN_ESR_PATH
     fi
@@ -39,14 +49,13 @@ esac
 
 case $COT_PRODUCT in
   firefox)
-    export APP_ID_BETA="org.mozilla.firefox"
-    export APP_ID_STABLE="org.mozilla.firefox"
+    export APP_ID="org.mozilla.firefox"
     export TASKCLUSTER_SCOPE_PREFIX="project:releng:flathub:firefox:"
     ;;
   thunderbird)
-    export APP_ID_BETA="org.mozilla.Thunderbird"
-    export APP_ID_STABLE="org.mozilla.ThunderbirdRelease"
-    export APP_ID_ESR="org.mozilla.Thunderbird"
+    export APP_ID="org.mozilla.Thunderbird"
+    export APP_ID_RELEASE="org.mozilla.ThunderbirdRelease"
+    export APP_ID_ESR="org.mozilla.ThunderbirdESR"
     export TASKCLUSTER_SCOPE_PREFIX="project:comm:thunderbird:releng:flathub:"
     ;;
   *)

pushflatpakscript/docker.d/worker.yml

@@ -2,11 +2,15 @@ work_dir: { "$eval": "WORK_DIR" }
 artifact_dir: { "$eval": "ARTIFACTS_DIR" }
 verbose: { "$eval": "VERBOSE == 'true'" }
 app_ids:
-  beta: {"$eval": "APP_ID_BETA" }
-  stable: {"$eval": "APP_ID_STABLE"}
+  beta: {"$eval": "APP_ID" }
+  stable: {"$eval": "APP_ID"}
+  release:
+    $if: defined("APP_ID_RELEASE")
+    then: {"$eval": "APP_ID_RELEASE"}
+    else: ''
   esr:
-    $if: 'COT_PRODUCT == "thunderbird"'
-    then: { "$eval": "APP_ID_ESR"}
+    $if: defined("APP_ID_ESR")
+    then: {"$eval": "APP_ID_ESR"}
     else: ''
 taskcluster_scope_prefix: { "$eval": "TASKCLUSTER_SCOPE_PREFIX" }
 push_to_flathub: { "$eval": "ENV == 'prod'" }
@@ -18,8 +22,13 @@ token_locations:
   then:
     beta: { "$eval": "REPO_TOKEN_BETA_PATH" }
     stable: { "$eval": "REPO_TOKEN_STABLE_PATH" }
+    release:
+      $if: defined("REPO_TOKEN_RELEASE_PATH")
+      then: {"$eval": "REPO_TOKEN_RELEASE_PATH"}
+      else: ''
     esr:
-      $if: 'COT_PRODUCT == "thunderbird"'
-      then: { "$eval": "REPO_TOKEN_ESR_PATH" }
+      $if: defined("REPO_TOKEN_ESR_PATH")
+      then: {"$eval": "REPO_TOKEN_ESR_PATH"}
       else: ''
+
   else: {}

pushflatpakscript/src/pushflatpakscript/flathub.py

@@ -150,7 +150,7 @@ def check_app_id_matches_flatpak(context, flatpak_path, channel):
     flatpak_refs = [ref.split("/")[1] for ref in flatpak_refs if ref.startswith("app/")]
 
     # Create a list, if any, of all unexpected Flatpak IDs present in repo
-    invalid_refs = set(flatpak_refs) - {context.config["app_ids"]}
+    invalid_refs = set(flatpak_refs) - set(context.config["app_ids"].values())
 
     if context.config["app_ids"][channel] not in flatpak_refs:
         raise TaskVerificationError(f"Supplied app ID ({context.config['app_ids'][channel]}) is not present in Flatpak!")
@@ -159,6 +159,15 @@ def check_app_id_matches_flatpak(context, flatpak_path, channel):
         raise TaskVerificationError("One or more invalid app IDs are present in Flatpak!")
 
 
+def check_config_for_channel(config, channel):
+    """Verify AppID and token location defined for supplied channel"""
+    if channel not in config["app_ids"]:
+        raise TaskVerificationError(f"Supplied channel ({channel}) does not have a configured appID")
+
+    if channel not in config["token_locations"]:
+        raise TaskVerificationError(f"Supplied channel ({channel}) does not have a configured token")
+
+
 def sanitize_buildid(bytes_input):
     """Flathub API returns bytes to we're decoding that to unicode string"""
     return bytes_input.decode().strip()
@@ -174,6 +183,8 @@ def push(context, flatpak_file_path, channel):
         # We don't raise an error because we still want green tasks on dev instances
         return
 
+    check_config_for_channel(context.config, channel)
+
     token_args = ["--token-file", context.config["token_locations"][channel]]
     log.info("Grab a flatpak buildid from Flathub ...")
     publish_build_output = run_flat_manager_client_process(

pushflatpakscript/src/pushflatpakscript/task.py

@@ -1,6 +1,6 @@
 from scriptworker.exceptions import TaskVerificationError
 
-_CHANNELS_AUTHORIZED_TO_REACH_FLATHUB = ("beta", "stable", "esr")
+_CHANNELS_AUTHORIZED_TO_REACH_FLATHUB = ("beta", "stable", "release", "esr")
 ALLOWED_CHANNELS = ("mock", *_CHANNELS_AUTHORIZED_TO_REACH_FLATHUB)
 
 

pushflatpakscript/tests/test_config.py

@@ -9,8 +9,9 @@
     "WORK_DIR": "",
     "ARTIFACTS_DIR": "",
     "VERBOSE": "true",
-    "APP_ID_STABLE": "",
-    "APP_ID_BETA": "",
+    "APP_ID": "",
+    "APP_ID_RELEASE": "",
+    "APP_ID_ESR": "",
     "COT_PRODUCT": "firefox",
     "TASKCLUSTER_SCOPE_PREFIX": "",
     "FLATHUB_URL": "https://flat.example",

pushflatpakscript/tests/test_task.py

@@ -35,7 +35,10 @@ def test_get_flatpak_channel_dep(raises, channel):
 )
 def test_get_flatpak_channel_prod(raises, scopes, channel):
     task = {"scopes": scopes, "payload": {"channel": channel}}
-    config = {"app_ids": {"stable": "org.mozilla.firefox", "beta": "org.mozilla.firefox"}, "taskcluster_scope_prefix": "project:releng:flathub:firefox:", "push_to_flathub": True}
+    config = {"app_ids": {"stable": "org.mozilla.firefox", "beta": "org.mozilla.firefox"},
+              "token_locations": {"stable": "stable.txt", "beta": "beta.txt"},
+              "taskcluster_scope_prefix": "project:releng:flathub:firefox:",
+              "push_to_flathub": True}
     if raises:
         with pytest.raises(TaskVerificationError):
             get_flatpak_channel(config, task)