updating ci container to support non web containers and push to a latest tag and badge

Author: thelamer

Dockerfile

@@ -9,9 +9,11 @@ RUN \
   docker && \
  echo "**** Install python deps ****" && \
  pip install --no-cache-dir \
+  requests \
   selenium \
   docker \
   boto3 \
+  anybadge \
   jinja2 && \
  echo "**** cleanup ****" && \
  rm -rf \

README.md

@@ -31,11 +31,8 @@ The container can be run locally, but it is meant to be integrated into the Linu
 sudo docker run --rm -i \
 -v /var/run/docker.sock:/var/run/docker.sock \
 -e IMAGE="linuxserver/<dockerimage>" \
--e DELAY_START=<time in seconds> \
 -e TAGS="<single tag or array seperated by |>" \
 -e META_TAG=<manifest main dockerhub tag> \
--e PORT=<port web application listens on internal docker port> \
--e SSL=<true/false> \
 -e BASE=<alpine or debian based distro> \
 -e SECRET_KEY=<Digital Ocean spaces secret> \
 -e ACCESS_KEY=<Digital Ocean spaces key> \
@@ -44,6 +41,10 @@ sudo docker run --rm -i \
 -e WEB_PATH="<optional, format /yourpath>" \
 -e DO_REGION=<optional, custom Digital Ocean Region> \
 -e DO_BUCKET=<optional, custom Digital Ocean Bucket> \
+-e WEB_SCREENSHOT=<optional, set to false if not a web app> \
+-e DELAY_START=<optional, time in seconds to delay before taking screenshot> \
+-e PORT=<optional, port web application listens on internal docker port> \
+-e SSL=<optional , use ssl for the screenshot true/false> \
 -t lsiodev/ci:latest \
 python /ci/ci.py
 ```

ci/ci.py

@@ -5,6 +5,8 @@
 import time
 import sys
 import docker
+import requests
+import anybadge
 from selenium import webdriver
 from selenium.common.exceptions import ErrorInResponseException,TimeoutException
 from jinja2 import Template
@@ -66,6 +68,10 @@ def convert_env(vars):
 global dockerenv
 global region
 global bucket
+global screenshot
+global port
+global ssl
+global testdelay
 try:
     webauth = os.environ["WEB_AUTH"]
 except KeyError:
@@ -86,24 +92,33 @@ def convert_env(vars):
     bucket = os.environ["DO_BUCKET"]
 except KeyError:
     bucket = 'lsio-ci'
-
+try:
+    screenshot = os.environ["WEB_SCREENSHOT"]
+except KeyError:
+    screenshot = 'false'
+try:
+    port = os.environ["PORT"]
+except KeyError:
+    port = '80'
+try:
+    ssl = os.environ["SSL"]
+except KeyError:
+    ssl = 'false'
+try:
+    testdelay = os.environ["DELAY_START"]
+except KeyError:
+    testdelay = '5'
 
 # Make sure all needed env variables are set
 def check_env():
     try:
         global image
-        global testdelay
         global tags
         global meta_tag
-        global port
-        global ssl
         global base
         global spaces_key
         global spaces_secret
         image = os.environ["IMAGE"]
-        testdelay = os.environ["DELAY_START"]
-        port = os.environ["PORT"]
-        ssl = os.environ["SSL"]
         base = os.environ["BASE"]
         spaces_key = os.environ["ACCESS_KEY"]
         spaces_secret = os.environ["SECRET_KEY"]
@@ -130,9 +145,13 @@ def  create_dir():
 # Take a screenshot using the webdriver
 def take_screenshot(endpoint,container_tag):
     try:
+        requests.get(endpoint, timeout=3)
         driver.get(endpoint)
         driver.get_screenshot_as_file(outdir + container_tag + '.png')
         report_tests.append(['Screenshot ' + container_tag,'PASS'])
+    except (requests.Timeout, requests.ConnectionError, KeyError) as e:
+        report_tests.append(['Screenshot ' + container_tag,'FAIL CONNECTION ERROR'])
+        mark_fail()
     except ErrorInResponseException as error:
         report_tests.append(['Screenshot ' + container_tag,'FAIL SERVER ERROR'])
         mark_fail()
@@ -167,16 +186,17 @@ def container_test(tag):
     elif logsfound == False:
         report_tests.append(['Startup ' + tag,'FAIL INIT NOT FINISHED'])
         mark_fail()
-    # Sleep for the user specified amount of time
-    time.sleep(int(testdelay))
-    # Take a screenshot
-    if ssl == 'true':
-        proto = 'https://'
-    else:
-        proto = 'http://'
-    container.reload()
-    ip = container.attrs["NetworkSettings"]["Networks"]["bridge"]["IPAddress"]
-    take_screenshot(proto + webauth + '@' + ip + ':' + port + webpath ,tag)
+    if screenshot == 'true':
+        # Sleep for the user specified amount of time
+        time.sleep(int(testdelay))
+        # Take a screenshot
+        if ssl == 'true':
+            proto = 'https://'
+        else:
+            proto = 'http://'
+        container.reload()
+        ip = container.attrs["NetworkSettings"]["Networks"]["bridge"]["IPAddress"]
+        take_screenshot(proto + webauth + '@' + ip + ':' + port + webpath ,tag)
     # Dump package information
     if base == 'alpine':
         command = 'apk info -v'
@@ -220,13 +240,23 @@ def report_render():
         meta_tag=meta_tag,
         image=image,
         bucket=bucket,
-        region=region)
+        region=region,
+        screenshot=screenshot)
     with open(outdir + 'report.md', 'w') as f:
         f.write(markdown)
 
+# Render the markdown file for upload
+def badge_render():
+    try:
+        badge = anybadge.Badge('CI', report_status, thresholds={'PASS': 'green', 'FAIL': 'red'})
+        badge.write_badge(outdir + 'badge.svg')
+    except Exception as error:
+        print(error)
+
 # Upload report to DO Spaces
 def report_upload():
     destination_dir = image + '/' + meta_tag + '/'
+    latest_dir = image + '/latest/'
     spaces = session.client(
         's3',
         region_name=region,
@@ -241,16 +271,33 @@ def report_upload():
             bucket,
             destination_dir + 'index.html',
             ExtraArgs={'ContentType': "text/html", 'ACL': "public-read"})
+        spaces.upload_file(
+            index_file,
+            bucket,
+            latest_dir + 'index.html',
+            ExtraArgs={'ContentType': "text/html", 'ACL': "public-read"})
     except Exception as error:
         core_fail('Upload Error ' + str(error))
     # Loop for all others
     for filename in os.listdir(outdir):
+        # Set content types for files
+        if filename.lower().endswith('.svg'):
+            CT = 'image/svg+xml'
+        elif filename.lower().endswith('.png'):
+            CT = 'image/png'
+        elif filename.lower().endswith('.md'):
+            CT = 'text/markdown'
         try:
             spaces.upload_file(
                 outdir + filename,
                 bucket,
                 destination_dir + filename,
-                ExtraArgs={'ACL': "public-read"})
+                ExtraArgs={'ContentType': CT,'ACL': "public-read"})
+            spaces.upload_file(
+                outdir + filename,
+                bucket,
+                latest_dir + filename,
+                ExtraArgs={'ContentType': CT,'ACL': "public-read"})
         except Exception as error:
             core_fail('Upload Error ' + str(error))
 
@@ -266,6 +313,7 @@ def report_upload():
 # Quit selenium webdriver
 driver.quit()
 report_render()
+badge_render()
 report_upload()
 # Exit based on test results
 if report_status == 'pass':

ci/results.template

@@ -10,10 +10,10 @@
 ## {{ image }}:{{ container["tag"] }}
 ### Build Version: {{ container["build_version"] }}
 
-### Screenshot
-
-[![{{ container["tag"] }}](https://{{ bucket }}.{{ region }}.digitaloceanspaces.com/{{ image }}/{{ meta_tag }}/{{ container["tag"] }}.png =600x*)](https://{{ bucket }}.{{ region }}.digitaloceanspaces.com/{{ image }}/{{ meta_tag }}/{{ container["tag"] }}.png)
+{% if screenshot == 'true' %}### Screenshot
 
+[![{{ container["tag"] }}]({{ container["tag"] }}.png =600x*)]({{ container["tag"] }}.png)
+{% endif %}
 ### Logs
 
 <details><summary>Expand</summary>