Dockerhub tags (#167)

* added new flag to build to retrieve image tags

* improved print system for container tags option

* added fix for components without container directives

Author: tiagofilipe12

changelog.md

@@ -7,7 +7,9 @@
 - Added new `recipe` system to flowcraft along with 6 starting recipes.
 Recipes are pre-made and curated pipelines that address specific questions.
 To create a recipe, the `-r <recipe_name>` can be used. To list available
-recipes, the `--recipe-list` and `--recipe-list-short` options were added.
+recipes, the `--recipe-list` and `--recipe-list-short` options were added. 
+- Added `-ft` or `--fetch-tags` which allows to retrieve all DockerHub 
+container tags.
 
 ### Components changes
 

flowcraft/flowcraft.py

@@ -113,6 +113,12 @@ def get_args(args=None):
                          "components (via -t option) in JSON format to stdout. "
                          "No pipeline will be generated with this option."
     )
+    build_parser.add_argument(
+        "-ft", "--fetch-tags", dest="fetch_docker_tags",
+        action="store_const", const=True, help="Allows to fetch all docker tags"
+                                               " for the components listed with"
+                                               " the -t flag."
+    )
 
     # GENERAL OPTIONS
     parser.add_argument(
@@ -191,9 +197,9 @@ def validate_build_arguments(args):
     if args.detailed_list or args.short_list:
         return
 
-    # Skill all checks when exporting parameters AND providing at least one
+    # Skip all checks when exporting parameters AND providing at least one
     # component
-    if args.export_params or args.export_directives:
+    if args.export_params or args.export_directives or args.fetch_docker_tags:
         # Check if components provided
         if not args.tasks:
             logger.error(colored_print(
@@ -284,7 +290,7 @@ def build(args):
 
     # Disable standard logging for stdout when the following modes are
     #  executed:
-    if args.export_params or args.export_directives:
+    if args.export_params or args.export_directives or args.fetch_docker_tags:
         logger.setLevel(logging.ERROR)
 
     if args.recipe_list_short:
@@ -357,6 +363,9 @@ def build(args):
     elif args.export_directives:
         nfg.export_directives()
         sys.exit(0)
+    elif args.fetch_docker_tags:
+        nfg.fetch_docker_tags()
+        sys.exit(0)
     else:
         # building the actual pipeline nf file
         nfg.build()

flowcraft/generator/engine.py

@@ -2,7 +2,9 @@
 import sys
 import json
 import jinja2
+import shutil
 import logging
+import requests
 
 from collections import defaultdict
 from os.path import dirname, join, abspath, split, splitext, exists, basename
@@ -1525,6 +1527,87 @@ def export_directives(self):
         # Flush params json to stdout
         sys.stdout.write(json.dumps(directives_json))
 
+    def fetch_docker_tags(self):
+        """
+        Export all dockerhub tags associated with each component given by
+        the -t flag.
+        """
+
+        # fetches terminal width and subtracts 1 because we always add a
+        # new line character
+        terminal_width = shutil.get_terminal_size().columns - 1
+
+        # first header
+        center_string = " Selected container tags "
+
+        # starts a list with the headers
+        tags_list = [
+            [
+                "=" * int(terminal_width / 4),
+                "{0}{1}{0}".format(
+                    "=" * int(((terminal_width/2 - len(center_string)) / 2)),
+                    center_string)
+                ,
+                "{}\n".format("=" * int(terminal_width / 4))
+            ],
+            ["component", "container", "tags"],
+            [
+                "=" * int(terminal_width / 4),
+                "=" * int(terminal_width / 2),
+                "=" * int(terminal_width / 4)
+            ]
+        ]
+
+        # Skip first init process and iterate through the others
+        for p in self.processes[1:]:
+            template = p.template
+            # fetch repo name from directives of the template. Since some
+            # components like integrity_coverage doesn't have a directives with
+            # container, thus if no directive there the script will skip this
+            # template
+            try:
+                repo = p.directives[template]["container"]
+            except KeyError:
+                continue
+            # make the request to docker hub
+            r = requests.get(
+                "https://hub.docker.com/v2/repositories/{}/tags/".format(
+                    repo
+                ))
+            # checks the status code of the request, if it is 200 then parses
+            # docker hub entry, otherwise retrieve no tags but alerts the user
+            if r.status_code != 404:
+                # parse response content to dict and fetch results key
+                r_content = json.loads(r.content)["results"]
+                for version in r_content:
+                    tags_list.append([template, repo, version["name"]])
+            else:
+                tags_list.append([template, repo, "No DockerHub tags"])
+
+        # iterate through each entry in tags_list and print the list of tags
+        # for each component. Each entry (excluding the headers) contains
+        # 3 elements (component name, container and tag version)
+        for x, entry in enumerate(tags_list):
+            # adds different color to the header in the first list and
+            # if row is pair add one color and if is even add another (different
+            # background)
+            color = "blue_bold" if x < 3 else \
+                ("white" if x % 2 != 0 else "0;37;40m")
+            # generates a small list with the terminal width for each column,
+            # this will be given to string formatting as the 3, 4 and 5 element
+            final_width = [
+                int(terminal_width/4),
+                int(terminal_width/2),
+                int(terminal_width/4)
+            ]
+            # writes the string to the stdout
+            sys.stdout.write(
+                colored_print("\n{0: <{3}} {1: ^{4}} {2: >{5}}".format(
+                    *entry, *final_width), color)
+            )
+        # assures that the entire line gets the same color
+        sys.stdout.write("\n")
+
     def build(self):
         """Main pipeline builder
 

flowcraft/generator/process_details.py

@@ -6,7 +6,7 @@
 COLORS = {
     "green_bold": "1;32m",
     "red_bold": "1;31m",
-    "white": "2;38m",
+    "white": "0;38m",
     "white_bold": "1;38m",
     "white_underline": "4;38m",
     "blue_bold": "1;36m",
@@ -37,7 +37,12 @@ def colored_print(msg, color_label="white_bold"):
     if sys.stdout.encoding != "UTF-8":
         msg = "".join([i if ord(i) < 128 else "" for i in msg])
 
-    col = COLORS[color_label]
+    # try except first looks for the color in COLORS dictionary, otherwise use
+    # color_label as the color.
+    try:
+        col = COLORS[color_label]
+    except KeyError:
+        col = color_label
 
     return "\x1b[{}{}\x1b[0m".format(col, msg)