Merge pull request #497 from camptocamp/backport/489-to-1.1

[Backport 1.1] Send dispatch event after the Docker publish

.prospector.yaml

@@ -23,6 +23,7 @@ pep8:
     max-line-length: 110
   disable:
     - E203 # whitespace before ':'
+    - W293 # blank line contains whitespace
     - E501 # line too long, Done by Black
 
 pep257:

c2cciutils/__init__.py

@@ -174,6 +174,10 @@ def get_config(branch: Optional[str] = None) -> c2cciutils.configuration.Configu
                     },
                     "dockerhub": {"versions": ["version_tag", "version_branch", "rebuild", "feature_branch"]},
                 },
+                "dispatch": {
+                    "event-type": "image-update",
+                    "repository": "camptocamp/argocd-gs-platform-ch-development-apps",
+                },
             },
             "helm": {
                 "versions": ["version_tag"],

c2cciutils/configuration.py

@@ -471,6 +471,21 @@
 )
 
 
+# dispatch config
+#
+# Send a dispatch event to an other repository
+DispatchConfig = TypedDict(
+    "DispatchConfig",
+    {
+        # The repository name to be triggered
+        "repository": str,
+        # The event type to be triggered
+        "event-type": str,
+    },
+    total=False,
+)
+
+
 # Print versions
 #
 # The print versions configuration
@@ -523,6 +538,10 @@
         "images": List["PublishDockerImage"],
         # The repository where we should publish the images
         "repository": Dict[str, "PublishDockerRepository"],
+        # Send a dispatch event to an other repository
+        #
+        # oneOf
+        "dispatch": Union["DispatchConfig", Literal[False]],
     },
     total=False,
 )

c2cciutils/publish.py

@@ -10,7 +10,7 @@
 import subprocess  # nosec
 import sys
 import uuid
-from typing import Optional
+from typing import List, Optional
 
 import ruamel.yaml
 from google.auth.transport.requests import Request
@@ -293,6 +293,7 @@ def docker(
     tag_src: str,
     tag_dst: str,
     latest: bool,
+    images_full: List[str],
 ) -> bool:
     """
     Publish to a Docker registry.
@@ -310,13 +311,15 @@ def docker(
         tag_src: The source tag (usually latest)
         tag_dst: The tag used for publication
         latest: Publish also the tag latest
+        images_full: The list of published images (with tag), used to build the dispatch event
     """
 
     print(f"::group::Publishing {image_config['name']}:{tag_dst} to {name}")
     sys.stdout.flush()
     sys.stderr.flush()
 
     try:
+        new_images_full = []
         if "server" in config:
             subprocess.run(
                 [
@@ -327,6 +330,7 @@ def docker(
                 ],
                 check=True,
             )
+            new_images_full.append(f"{config['server']}/{image_config['name']}:{tag_dst}")
             if latest:
                 subprocess.run(
                     [
@@ -337,19 +341,7 @@ def docker(
                     ],
                     check=True,
                 )
-            subprocess.run(
-                [
-                    "docker",
-                    "push",
-                    f"{config['server']}/{image_config['name']}:{tag_dst}",
-                ],
-                check=True,
-            )
-            if latest:
-                subprocess.run(
-                    ["docker", "push", f"{config['server']}/{image_config['name']}:{tag_src}"],
-                    check=True,
-                )
+                new_images_full.append(f"{config['server']}/{image_config['name']}:{tag_src}")
         else:
             if tag_src != tag_dst:
                 subprocess.run(
@@ -361,19 +353,14 @@ def docker(
                     ],
                     check=True,
                 )
-            subprocess.run(
-                ["docker", "push", f"{image_config['name']}:{tag_dst}"],
-                check=True,
-            )
-            if latest:
-                subprocess.run(
-                    [
-                        "docker",
-                        "push",
-                        f"{image_config['name']}:{tag_src}",
-                    ],
-                    check=True,
-                )
+            new_images_full.append(f"{image_config['name']}:{tag_dst}")
+            if latest and tag_src != tag_dst:
+                new_images_full.append(f"{image_config['name']}:{tag_src}")
+
+        for image in new_images_full:
+            subprocess.run(["docker", "push", image], check=True)
+        images_full += new_images_full
+
         print("::endgroup::")
     except subprocess.CalledProcessError as exception:
         print(f"Error: {exception}")

c2cciutils/schema.json

@@ -526,6 +526,27 @@
                   }
                 }
               }
+            },
+            "dispatch": {
+              "description": "Send a dispatch event to an other repository",
+              "oneOf": [
+                {
+                  "type": "object",
+                  "title": "dispatch config",
+                  "description": "Send a dispatch event to an other repository",
+                  "properties": {
+                    "repository": {
+                      "description": "The repository name to be triggered",
+                      "type": "string"
+                    },
+                    "event-type": {
+                      "description": "The event type to be triggered",
+                      "type": "string"
+                    }
+                  }
+                },
+                { "const": false }
+              ]
             }
           }
         },

c2cciutils/scripts/publish.py

@@ -10,14 +10,15 @@
 import subprocess  # nosec
 import sys
 import tarfile
-from typing import Match, Optional, cast
+from typing import List, Match, Optional, cast
 
 import requests
 
 import c2cciutils.configuration
 import c2cciutils.publish
 import c2cciutils.security
 from c2cciutils.publish import GoogleCalendar
+from c2cciutils.scripts.trigger_image_update import dispatch
 
 
 def match(tpe: str, base_re: str) -> Optional[Match[str]]:
@@ -187,6 +188,7 @@ def main() -> None:
             version_index = security.headers.index("Version")
             latest = security.data[-1][version_index] == version
 
+        images_full: List[str] = []
         for image_conf in docker_config.get("images", []):
             if image_conf.get("group", "") == args.group:
                 for tag_config in image_conf.get("tags", []):
@@ -206,7 +208,7 @@ def main() -> None:
                                     )
                             else:
                                 success &= c2cciutils.publish.docker(
-                                    conf, name, image_conf, tag_src, tag_dst, latest
+                                    conf, name, image_conf, tag_src, tag_dst, latest, images_full
                                 )
                     if version_type in google_calendar_config.get("on", []):
                         if not google_calendar:
@@ -219,6 +221,10 @@ def main() -> None:
 
                         google_calendar.create_event(summary, description)
 
+        dispatch_config = docker_config.get("dispatch", False)
+        if dispatch_config:
+            dispatch(dispatch_config["repository"], dispatch_config["event-type"], images_full)
+
     helm_config = cast(
         c2cciutils.configuration.PublishHelmConfig,
         config.get("publish", {}).get("helm", {}) if config.get("publish", {}).get("helm", False) else {},

c2cciutils/scripts/trigger_image_update.py

@@ -8,6 +8,7 @@
 import os.path
 import subprocess  # nosec
 import sys
+from typing import List
 
 import requests
 import yaml
@@ -55,8 +56,16 @@ def main() -> None:
         for image_config in ci_config.get("publish", {}).get("docker", {}).get("images", []):
             images_full.append(image_config["name"])
 
+    dispatch(args.repository, args.event_type, [f"{image}:{version}" for image in images_full])
+
+
+def dispatch(repository: str, event_type: str, images_full: List[str]) -> None:
+    """
+    Trigger an image update on the argocd repository.
+    """
+
     response = requests.post(
-        f"https://api.github.com/repos/{args.repository}/dispatches",
+        f"https://api.github.com/repos/{repository}/dispatches",
         headers={
             "Content-Type": "application/json2",
             "Accept": "application/vnd.github.v3+json",
@@ -68,8 +77,8 @@ def main() -> None:
             .strip(),
         },
         json={
-            "event_type": args.event_type,
-            "client_payload": {"name": " ".join([f"{image}:{version}" for image in images_full])},
+            "event_type": event_type,
+            "client_payload": {"name": " ".join(images_full)},
         },
     )
     response.raise_for_status()