aws-crt 0.1.5 → 0.1.6

data/aws-crt-ffi/crt/s2n/tests/litani/examples/rich-output/run-1.sh

@@ -0,0 +1,41 @@
+#!/bin/sh
+#
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License").
+# You may not use this file except in compliance with the License.
+# A copy of the License is located at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# or in the "license" file accompanying this file. This file is distributed
+# on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+# express or implied. See the License for the specific language governing
+# permissions and limitations under the License.
+
+LITANI=${LITANI:-litani}
+
+if [ "$1" != "--no-standalone" ]; then
+  "${LITANI}" init --project-name "literal-stdout-examples"
+fi
+
+"${LITANI}" add-job \
+  --pipeline-name "verify assumptions" \
+  --description "list out assumptions" \
+  --command "cat assumptions.html" \
+  --ci-stage test \
+  --phony-outputs assumptions.html \
+  --tags literal-stdout
+
+"${LITANI}" add-job \
+  --pipeline-name "conduct analysis" \
+  --description "generate the histogram" \
+  --command "gnuplot -c histogram.dat" \
+  --ci-stage report \
+  --inputs file.dat \
+  --phony-outputs histogram.svg \
+  --tags literal-stdout
+
+if [ "$1" != "--no-standalone" ]; then
+  "${LITANI}" run-build
+fi

data/aws-crt-ffi/crt/s2n/tests/litani/examples/rich-output/run-2.sh

@@ -0,0 +1,47 @@
+#!/bin/sh
+#
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License").
+# You may not use this file except in compliance with the License.
+# A copy of the License is located at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# or in the "license" file accompanying this file. This file is distributed
+# on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+# express or implied. See the License for the specific language governing
+# permissions and limitations under the License.
+
+LITANI=${LITANI:-litani}
+
+if [ "$1" != "--no-standalone" ]; then
+  "${LITANI}" init --project-name "front-page-output examples"
+fi
+
+"${LITANI}" add-job \
+    --pipeline-name "fibonacci" \
+    --description "write fibonacci to csv" \
+    --command "python3 scripts/fib.py -o fib.csv" \
+    --ci-stage test \
+    --outputs "fib.csv"
+
+"${LITANI}" add-job \
+    --pipeline-name "fibonacci" \
+    --description "plot fibonacci results" \
+    --command "gnuplot scripts/fib.plt" \
+    --ci-stage report \
+    --inputs "fib.csv" \
+    --tags "front-page-text"
+
+"${LITANI}" add-job \
+    --pipeline-name "fibonacci" \
+    --description "table fibonacci results" \
+    --command "python3 scripts/fib-table.py -i fib.csv" \
+    --ci-stage report \
+    --inputs "fib.csv" \
+    --tags "front-page-text"
+
+if [ "$1" != "--no-standalone" ]; then
+  "${LITANI}" run-build
+fi

data/aws-crt-ffi/crt/s2n/tests/litani/examples/rich-output/run-3.sh

@@ -0,0 +1,41 @@
+#!/bin/sh
+#
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License").
+# You may not use this file except in compliance with the License.
+# A copy of the License is located at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# or in the "license" file accompanying this file. This file is distributed
+# on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+# express or implied. See the License for the specific language governing
+# permissions and limitations under the License.
+
+LITANI=${LITANI:-litani}
+
+if [ "$1" != "--no-standalone" ]; then
+  "${LITANI}" init \
+    --project-name "front-page-output and literal-stdout examples"
+fi
+
+"${LITANI}" add-job \
+    --pipeline-name "sin" \
+    --description "write sin to csv" \
+    --command "python3 scripts/sin.py -o sin.csv" \
+    --ci-stage test \
+    --outputs "sin.csv"
+
+"${LITANI}" add-job \
+    --pipeline-name "sin" \
+    --description "display sin results" \
+    --command \
+    "gnuplot scripts/sin.plt; python3 scripts/sin-output.py -i sin.csv" \
+    --ci-stage report \
+    --inputs "sin.csv" \
+    --tags front-page-text literal-stdout
+
+if [ "$1" != "--no-standalone" ]; then
+  "${LITANI}" run-build
+fi

data/aws-crt-ffi/crt/s2n/tests/litani/examples/rich-output/run-all.py

@@ -0,0 +1,34 @@
+#!/usr/bin/env python3
+#
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License").
+# You may not use this file except in compliance with the License.
+# A copy of the License is located at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# or in the "license" file accompanying this file. This file is distributed
+# on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+# express or implied. See the License for the specific language governing
+# permissions and limitations under the License.
+
+
+import os
+import pathlib
+import re
+import subprocess
+
+
+litani = os.getenv("LITANI", "litani")
+this_dir = pathlib.Path(__file__).parent
+
+subprocess.run(
+    [litani, "init", "--project-name", "rich-output-examples"], check=True)
+
+pat = re.compile(r"run-\d.sh")
+for fyle in this_dir.iterdir():
+    if pat.match(fyle.name):
+        subprocess.run([fyle, "--no-standalone"], check=True)
+
+subprocess.run([litani, "run-build"], check=True)

data/aws-crt-ffi/crt/s2n/tests/litani/examples/rich-output/scripts/fib-table.py

@@ -0,0 +1,40 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License").
+# You may not use this file except in compliance with the License.
+# A copy of the License is located at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# or in the "license" file accompanying this file. This file is distributed
+# on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+# express or implied. See the License for the specific language governing
+# permissions and limitations under the License.
+
+import argparse
+import jinja2
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("-i", "--input", required=True, help="input csv")
+    args = parser.parse_args()
+
+    data = {}
+    with open(args.input, "r") as handle:
+        for line in handle:
+            values = line.split(',')
+            data[int(values[0].strip())] = int(values[1].strip())
+
+    env = jinja2.Environment(
+        loader=jinja2.FileSystemLoader("./templates"),
+        autoescape=jinja2.select_autoescape(
+            enabled_extensions=('csv'),
+            default_for_string=True))
+    table_template = env.get_template("fib-table.jinja.html")
+    table = table_template.render(data=data)
+    print(table)
+
+
+if __name__ == "__main__":
+    main()

data/aws-crt-ffi/crt/s2n/tests/litani/examples/rich-output/scripts/fib.plt

@@ -0,0 +1,5 @@
+set term svg
+set style fill solid border
+set xlabel "nth fibonacci number"
+set ylabel "value"
+plot "fib.csv" with linespoints

data/aws-crt-ffi/crt/s2n/tests/litani/examples/rich-output/scripts/fib.py

@@ -0,0 +1,32 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License").
+# You may not use this file except in compliance with the License.
+# A copy of the License is located at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# or in the "license" file accompanying this file. This file is distributed
+# on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+# express or implied. See the License for the specific language governing
+# permissions and limitations under the License.
+
+import argparse
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("-o", "--output", required=True, help="output file")
+    args = parser.parse_args()
+    n = 10
+    fib = [0] * n
+    fib[1] = 1
+    for i in range(2, n):
+        fib[i] = fib[i-1] + fib[i-2]
+    with open(args.output, "w") as handle:
+        for index, value in enumerate(fib, 1):
+            print(f"{index}, {value}", file=handle)
+
+
+if __name__ == "__main__":
+    main()

data/aws-crt-ffi/crt/s2n/tests/litani/examples/rich-output/scripts/sin-output.py

@@ -0,0 +1,40 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License").
+# You may not use this file except in compliance with the License.
+# A copy of the License is located at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# or in the "license" file accompanying this file. This file is distributed
+# on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+# express or implied. See the License for the specific language governing
+# permissions and limitations under the License.
+
+import argparse
+import jinja2
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("-i", "--input", required=True, help="input csv")
+    args = parser.parse_args()
+
+    data = {}
+    with open(args.input, "r") as handle:
+        for line in handle:
+            values = line.split(',')
+            data[float(values[0].strip())] = float(values[1].strip())
+
+    env = jinja2.Environment(
+        loader=jinja2.FileSystemLoader("./templates"),
+        autoescape=jinja2.select_autoescape(
+            enabled_extensions=('csv'),
+            default_for_string=True))
+    table_template = env.get_template("sin-output.jinja.html")
+    output = table_template.render(data=data)
+    print(output)
+
+
+if __name__ == "__main__":
+    main()

data/aws-crt-ffi/crt/s2n/tests/litani/examples/rich-output/scripts/sin.plt

@@ -0,0 +1,5 @@
+set term svg
+set style fill solid border
+set xlabel "x"
+set ylabel "sin(x)"
+plot 0, "sin.csv" smooth csplines

data/aws-crt-ffi/crt/s2n/tests/litani/examples/rich-output/scripts/sin.py

@@ -0,0 +1,30 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License").
+# You may not use this file except in compliance with the License.
+# A copy of the License is located at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# or in the "license" file accompanying this file. This file is distributed
+# on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+# express or implied. See the License for the specific language governing
+# permissions and limitations under the License.
+
+import argparse
+import math
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("-o", "--output", required=True, help="output file")
+    args = parser.parse_args()
+    with open(args.output, "w") as handle:
+        for i in range(9):
+            val = ((2.0 * math.pi) / 8.0) * i
+            print(f"{val}, {math.sin(val)}",
+                file=handle)
+
+
+if __name__ == "__main__":
+    main()

data/aws-crt-ffi/crt/s2n/tests/litani/examples/rich-output/templates/fib-table.jinja.html

@@ -0,0 +1,45 @@
+<div>
+  <style type="text/css" scoped>
+    table {
+      background-color: white;
+      color: black;
+      text-align: center;
+      padding: 1em;
+      border-radius: 0.3em;
+    }
+    th {
+      border-bottom: 3px solid black;
+    }
+    th, td {
+      padding: 0.5em;
+      margin: 0.3em;
+    }
+    .danger {
+      background-color: #ff8585;
+    }
+    .warning {
+      background-color: #fff5ab;
+    }
+    .good {
+      background-color: #ceffc9;
+    }
+  </style>
+  <table>
+    <th>nth fibonacci number</th>
+    <th>value</th>
+    {% for n, value in data.items() %}
+      <tr>
+        <td>{{ n }}</td>
+        {% if value > 30 %}
+          <td class="danger">
+        {% elif value > 10 %}
+          <td class="warning">
+        {% else %}
+          <td class="good">
+        {% endif %}
+            {{ value }}
+          </td>
+      {% endfor %}
+      </tr>
+  </table>
+</div>

data/aws-crt-ffi/crt/s2n/tests/litani/examples/rich-output/templates/sin-output.jinja.html

@@ -0,0 +1,30 @@
+<div>
+  <style type="text/css" scoped>
+    table {
+      background-color: white;
+      color: black;
+      text-align: center;
+      padding: 1em;
+      border-radius: 0.3em;
+      margin: auto;
+      width: 50%;
+    }
+    th {
+      border-bottom: 3px solid black;
+    }
+    th, td {
+      padding: 0.5em;
+      margin: 0.3em;
+    }
+  </style>
+  <table>
+    <th>x</th>
+    <th>sin(x)</th>
+    {% for n, value in data.items() %}
+      <tr>
+        <td>{{ n }}</td>
+        <td>{{ value }}</td>
+      </tr>
+    {% endfor %}
+  </table>
+</div>

data/aws-crt-ffi/crt/s2n/tests/litani/lib/add_job.py

@@ -0,0 +1,55 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License").
+# You may not use this file except in compliance with the License.
+# A copy of the License is located at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# or in the "license" file accompanying this file. This file is distributed
+# on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+# express or implied. See the License for the specific language governing
+# permissions and limitations under the License
+
+import json
+import logging
+import sys
+import uuid
+
+from lib import litani
+
+
+async def add_job(job_dict):
+    cache_file = litani.get_cache_dir() / litani.CACHE_FILE
+    with open(cache_file) as handle:
+        cache_contents = json.load(handle)
+    if job_dict["ci_stage"] not in cache_contents["stages"]:
+        valid_stages = "', '".join(cache_contents["stages"])
+        logging.error(
+            "Invalid stage name '%s' was provided, possible "
+            "stage names are: '%s'", job_dict["ci_stage"], valid_stages)
+        sys.exit(1)
+
+    jobs_dir = litani.get_cache_dir() / litani.JOBS_DIR
+    jobs_dir.mkdir(exist_ok=True, parents=True)
+
+    if job_dict["phony_outputs"]:
+        if not job_dict["outputs"]:
+            job_dict["outputs"] = job_dict["phony_outputs"]
+        else:
+            for phony_output in job_dict["phony_outputs"]:
+                if phony_output not in job_dict["outputs"]:
+                    job_dict["outputs"].append(phony_output)
+
+    if "func" in job_dict:
+        job_dict.pop("func")
+
+    job_id = str(uuid.uuid4())
+    job_dict["job_id"] = job_id
+    job_dict["status_file"] = str(
+        litani.get_status_dir() / ("%s.json" % job_id))
+
+    logging.debug("Adding job: %s", json.dumps(job_dict, indent=2))
+
+    with litani.atomic_write(jobs_dir / ("%s.json" % job_id)) as handle:
+        print(json.dumps(job_dict, indent=2), file=handle)

data/aws-crt-ffi/crt/s2n/tests/litani/lib/graph.py

@@ -56,12 +56,12 @@ class DependencyNode(Node):
         self.id = hash(fyle)
 
         path = pathlib.Path(fyle)
-        _, ext = os.path.splitext(path.name)
+        name, ext = os.path.splitext(path.name)
 
         self.style = style
 
         wrapper = get_text_wrapper(line_width)
-        path_name = "\n".join(wrapper.wrap(path.name))
+        path_name = "\n".join(wrapper.wrap(name))
         self.style["label"] = f"{path_name}{ext}"
 
 

data/aws-crt-ffi/crt/s2n/tests/litani/lib/litani.py

@@ -33,7 +33,7 @@ TIME_FORMAT_R = "%Y-%m-%dT%H:%M:%SZ"
 TIME_FORMAT_W = "%Y-%m-%dT%H:%M:%SZ"
 TIME_FORMAT_MS = "%Y-%m-%dT%H:%M:%S.%fZ"
 VERSION_MAJOR = 1
-VERSION_MINOR = 17
+VERSION_MINOR = 22
 VERSION_PATCH = 0
 RC = False
 
@@ -239,6 +239,11 @@ def add_jobs_to_cache():
     jobs = []
     cache_dir = get_cache_dir()
     jobs_dir = cache_dir / JOBS_DIR
+    if not jobs_dir.exists():
+        logging.error(
+            "Cannot run build: no jobs were added. Run `litani add-job` one or "
+            "more times before running `litani run-build`.")
+        sys.exit(1)
     for job_file in os.listdir(jobs_dir):
         with open(jobs_dir / job_file) as handle:
             jobs.append(json.load(handle))

data/aws-crt-ffi/crt/s2n/tests/litani/lib/litani_report.py

@@ -464,7 +464,7 @@ def sort_run(run):
         pipe["ci_stages"] = stages
         add_pipe_stats(pipe)
         pipelines.append(pipe)
-    pipelines = sorted(pipelines, key=lambda p: p["status"])
+    pipelines = sorted(pipelines, key=lambda p: (p["status"], p["name"]))
     run["pipelines"] = pipelines
     add_run_stats(run)
 
@@ -508,17 +508,6 @@ def get_dashboard_svgs(run, env, gnuplot):
     }
 
 
-def get_git_hash():
-    try:
-        cmd = ["git", "show", "--no-patch", "--pretty=format:%h"]
-        litani_dir = pathlib.Path(os.path.realpath(__file__)).parent
-        proc = subprocess.run(
-            cmd, text=True, stdout=subprocess.PIPE, check=True, cwd=litani_dir)
-        return proc.stdout.strip()
-    except RuntimeError:
-        return None
-
-
 def get_summary(run):
     ret = {
         "in_progress": 0,
@@ -555,18 +544,10 @@ def render(run, report_dir, pipeline_depgraph_renderer):
 
     litani_report_archive_path = os.getenv("LITANI_REPORT_ARCHIVE_PATH")
 
-    dash_templ = env.get_template("dashboard.jinja.html")
-    page = dash_templ.render(
-        run=run, svgs=svgs, litani_hash=get_git_hash(),
-        litani_version=litani.VERSION,
-        litani_report_archive_path=litani_report_archive_path,
-        summary=get_summary(run))
-    with litani.atomic_write(temporary_report_dir / "index.html") as handle:
-        print(page, file=handle)
-
     with litani.atomic_write(temporary_report_dir / litani.RUN_FILE) as handle:
         print(json.dumps(run, indent=2), file=handle)
 
+    front_page_outputs = {}
     pipe_templ = env.get_template("pipeline.jinja.html")
     for pipe in run["pipelines"]:
         pipeline_depgraph_renderer.render(
@@ -581,11 +562,27 @@ def render(run, report_dir, pipeline_depgraph_renderer):
                     MemoryTraceRenderer.render(
                         temporary_report_dir / pipe["url"], env, job, gnuplot)
 
+                tags = job["wrapper_arguments"]["tags"]
+                description = job["wrapper_arguments"]["description"]
+                if tags and "front-page-text" in tags:
+                    if "stdout" in job and job["stdout"]:
+                        front_page_outputs[description] = job
+
         pipe_page = pipe_templ.render(run=run, pipe=pipe)
         with litani.atomic_write(
                 temporary_report_dir / pipe["url"] / "index.html") as handle:
             print(pipe_page, file=handle)
 
+    dash_templ = env.get_template("dashboard.jinja.html")
+    page = dash_templ.render(
+        run=run, svgs=svgs,
+        litani_version=litani.VERSION,
+        litani_report_archive_path=litani_report_archive_path,
+        summary=get_summary(run), front_page_outputs=front_page_outputs)
+
+    with litani.atomic_write(temporary_report_dir / "index.html") as handle:
+        print(page, file=handle)
+
 
     temp_symlink_dir = report_dir.with_name(report_dir.name + str(uuid.uuid4()))
     os.symlink(temporary_report_dir, temp_symlink_dir)

data/aws-crt-ffi/crt/s2n/tests/litani/lib/ninja.py

@@ -57,6 +57,8 @@ class _OutputAccumulator:
 
     @staticmethod
     def get_tty_width():
+        if os.getenv("TERM") is None:
+            return 80
         try:
             proc = subprocess.run(
                 ["tput", "cols"], text=True, stdout=subprocess.PIPE, check=True)

data/aws-crt-ffi/crt/s2n/tests/litani/lib/run_printer.py

@@ -112,8 +112,12 @@ def get_run_checker():
 
 
 
-def _exit_success(run):
-    print(json.dumps(run, indent=2))
+def _exit_success(run, out_file):
+    if out_file:
+        with lib.litani.atomic_write(out_file) as handle:
+            print(json.dumps(run, indent=2), file=handle)
+    else:
+        print(json.dumps(run, indent=2))
     sys.exit(0)
 
 
@@ -122,13 +126,27 @@ def _exit_error():
     sys.exit(0)
 
 
-def _try_dump_run(cache_dir, pid, sleeper, check_run):
-    os.kill(pid, DUMP_SIGNAL)
+def _try_dump_run(cache_dir, pid, sleeper, check_run, out_file):
+    try:
+        os.kill(pid, DUMP_SIGNAL)
+    except ProcessLookupError:
+        logging.debug("pid %s does not match to a running process", pid)
+        latest_run_file = cache_dir / lib.litani.RUN_FILE
+        try:
+            with open(latest_run_file) as handle:
+                latest_run = json.load(handle)
+            check_run(latest_run)
+            _exit_success(latest_run, out_file)
+        except (
+            FileNotFoundError, json.decoder.JSONDecodeError,
+            InconsistentRunError):
+            logging.warning("Could not find run.json inside the latest run")
+            _exit_error()
     try:
         with open(cache_dir / _DUMPED_RUN) as handle:
             run = json.load(handle)
         check_run(run)
-        _exit_success(run)
+        _exit_success(run, out_file)
     except (
             FileNotFoundError, json.decoder.JSONDecodeError,
             InconsistentRunError):
@@ -147,13 +165,14 @@ async def dump_run(args):
 
     sleeper = BackoffSleeper(jitter=random.random())
     check_run = get_run_checker()
+    out_file = args.out_file if args.out_file else None
 
     if args.retries:
         for _ in range(args.retries):
-            _try_dump_run(cache_dir, pid, sleeper, check_run)
+            _try_dump_run(cache_dir, pid, sleeper, check_run, out_file)
     else:
         while True:
-            _try_dump_run(cache_dir, pid, sleeper, check_run)
+            _try_dump_run(cache_dir, pid, sleeper, check_run, out_file)
     _exit_error()