aws-crt 0.1.5 → 0.1.6

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

@@ -0,0 +1,84 @@
+# 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 dataclasses
+import json
+import logging
+import os
+import pathlib
+import sys
+
+import lib.litani
+import lib.add_job
+
+
+@dataclasses.dataclass
+class _JobsTransformer:
+    jobs_dir: pathlib.Path
+    old_uuids: list
+
+
+    async def __call__(self, user_jobs):
+        self._delete_old_jobs()
+        await self._add_new_jobs(user_jobs)
+
+
+    async def _add_new_jobs(self, user_jobs):
+        for job in user_jobs:
+            job["subcommand"] = "add-job"
+            await lib.add_job.add_job(job)
+
+
+    def _delete_old_jobs(self):
+        for uuid in self.old_uuids:
+            job_file = self.jobs_dir / ("%s.json" % uuid)
+            try:
+                os.unlink(job_file)
+            except FileNotFoundError:
+                continue
+
+
+
+def _print_jobs(job_paths):
+    out = []
+    for job in job_paths:
+        with open(job) as handle:
+            job_dict = json.load(handle)
+            for key in ("job_id", "status_file", "subcommand"):
+                job_dict.pop(key)
+            out.append(job_dict)
+    print(json.dumps(out, indent=2))
+    sys.stdout.flush()
+    os.close(sys.stdout.fileno())
+
+
+def _read_jobs():
+    in_text = sys.stdin.read()
+    return json.loads(in_text)
+
+
+async def main(_):
+    jobs_dir = lib.litani.get_cache_dir() / lib.litani.JOBS_DIR
+    old_jobs = list()
+    old_uuids = set()
+    for job in jobs_dir.iterdir():
+        old_jobs.append(job)
+        old_uuids.add(str(job.stem))
+
+    _print_jobs(old_jobs)
+
+    new_jobs = _read_jobs()
+
+    transform = _JobsTransformer(jobs_dir, old_uuids)
+    await transform(new_jobs)

data/aws-crt-ffi/crt/s2n/tests/litani/litani

@@ -32,6 +32,7 @@ import traceback
 import uuid
 
 from lib import litani, litani_report, ninja_syntax
+import lib.add_job
 import lib.capabilities
 import lib.graph
 import lib.job_outcome
@@ -40,6 +41,7 @@ import lib.ninja
 import lib.pid_file
 import lib.process
 import lib.run_printer
+import lib.transform_jobs
 import lib.validation
 
 
@@ -259,6 +261,11 @@ def get_args():
             "help":
                 "how many times to retry loading the run in 1 second intervals"
                 " (Default: %(default)s)"
+        }, {
+            "flags": ["-o", "--out-file"],
+            "metavar": "F",
+            "type": _non_directory_path,
+            "help": "Output file to dump run file in"
     }]:
         flags = arg.pop("flags")
         dump_run_pars.add_argument(*flags, **arg)
@@ -274,6 +281,13 @@ def get_args():
         flags = arg.pop("flags")
         graph_pars.add_argument(*flags, **arg)
 
+    transform_jobs_pars = subs.add_parser("transform-jobs",
+        help="print jobs, then read jobs on stdin to save")
+    transform_jobs_pars.set_defaults(func=lib.transform_jobs.main)
+    for arg in []:
+        flags = arg.pop("flags")
+        transform_jobs_pars.add_argument(*flags, **arg)
+
     caps_pars = subs.add_parser("print-capabilities",
         help="Print out Litani's capabilities in a list")
     caps_pars.set_defaults(func=lib.capabilities.dump)
@@ -408,6 +422,14 @@ def non_negative_int(arg):
     return ret
 
 
+def _non_directory_path(arg):
+    path = pathlib.Path(arg)
+    if path.exists() and path.is_dir():
+        raise ValueError(
+          f"--out-file flag expects a file and not a directory: {arg}")
+    return path
+
+
 def list_of_ints(arg):
     ret = []
     for rc in arg:
@@ -620,39 +642,7 @@ async def init(args):
 
 
 async def add_job(args):
-    cache_file = litani.get_cache_dir() / litani.CACHE_FILE
-    with open(cache_file) as handle:
-        cache_contents = json.load(handle)
-    if args.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'", args.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 args.phony_outputs:
-        if not args.outputs:
-            args.outputs = args.phony_outputs
-        else:
-            for phony_output in args.phony_outputs:
-                if phony_output not in args.outputs:
-                    args.outputs.append(phony_output)
-
-    job = vars(args)
-    job.pop("func")
-
-    job_id = str(uuid.uuid4())
-    job["job_id"] = job_id
-    job["status_file"] = str(
-        litani.get_status_dir() / ("%s.json" % job_id))
-
-    logging.debug("Adding job: %s", json.dumps(job, indent=2))
-
-    with litani.atomic_write(jobs_dir / ("%s.json" % job_id)) as handle:
-        print(json.dumps(job, indent=2), file=handle)
+    await lib.add_job.add_job(vars(args))
 
 
 async def run_build(args):
@@ -782,6 +772,11 @@ async def exec_job(args):
             with litani.atomic_write(arg_file) as handle:
                 print(out_str, file=handle)
 
+    if out_data["wrapper_return_code"] and out_data["stderr"]:
+        print(
+            "\n".join([l.rstrip() for l in out_data["stderr"]]),
+            file=sys.stderr)
+
     timestamp("end_time", out_data)
     out_str = json.dumps(out_data, indent=2)
     logging.debug("run status: %s", out_str)

data/aws-crt-ffi/crt/s2n/tests/litani/script/release

@@ -0,0 +1,220 @@
+#!/bin/sh
+# vim: syntax=make ft=make
+#
+# 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.
+
+
+# This file is a shell script that writes the bottom half of itself to a
+# Makefile, and then runs that Makefile with make. It maintains state in the
+# tmp/litani-release directory, so you can read the files in there to help with
+# debugging.
+
+MAKEFILE_START_LINE=$(\
+  grep -ne '^# 8><' "$0" \
+  | tail -n 1 \
+  | awk -F: '{print $1}')
+
+LITANI_RELEASE=tmp/litani-release
+mkdir -p "${LITANI_RELEASE}"
+
+MAKEFILE=${LITANI_RELEASE}/Makefile
+tail -n+${MAKEFILE_START_LINE} "$0" > "${MAKEFILE}"
+
+make -Bj 1 -f "${MAKEFILE}"
+SUCCESS="$?"
+
+exit "${SUCCESS}"
+
+# 8>< - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+#
+# Makefile starts here
+
+TMP=tmp/litani-release
+
+SANITY_CHECKS = \
+	check-upstream-origin \
+	check-branches-up-to-date \
+	check-tac-installed
+
+RELEASE_PROCESS = \
+	checkout-develop \
+	merge-develop-release \
+	commit-changelog \
+	tag-release \
+	create-rc
+
+STATE_FILES = \
+	$(TMP)/current-release-number \
+	$(TMP)/rc-number \
+	$(TMP)/commits.json
+
+create-release: $(SANITY_CHECKS) $(STATE_FILES) $(RELEASE_PROCESS)
+	$(info --- Finished)
+	git checkout release
+	@>&2 printf '\n```````````````````````````````````````````````````````````\n'
+	@>&2 printf "Now run\n\n"
+	@>&2 printf "  git push -u origin release\n"
+	@>&2 printf "  git checkout develop\n"
+	@>&2 printf "  git push -u origin develop\n"
+	@>&2 printf "  git push origin --tags\n\n"
+	@>&2 printf '___________________________________________________________\n'
+
+.PHONY: $(SANITY_CHECKS) $(PHONY_DEPS)
+
+check-upstream-origin:
+	$(info --- Checking that 'origin' remote points to upstream repository)
+	git remote show -n origin \
+	  | grep -e 'Fetch URL:\s\+.\+awslabs/aws-build-accumulator'
+
+check-branches-up-to-date:
+	$(info --- Ensuring local branches track upstream)
+	[ $$(git rev-parse develop) = $$(git rev-parse origin/develop) ]
+	[ $$(git rev-parse release) = $$(git rev-parse origin/release) ]
+
+
+check-tac-installed:
+	$(info --- Testing for 'tac' installation)
+	printf '' | tac
+
+checkout-develop:
+	$(info --- Checking out develop)
+	git checkout develop
+
+create-rc: $(TMP)/rc-number
+	$(info --- Creating new release candidate on develop branching off release)
+	git checkout -B develop
+	new_minor=$$(cat $(TMP)/rc-number); \
+	  sed -E \
+	    -e "s/^VERSION_MINOR.+/VERSION_MINOR = $${new_minor}/g" \
+	    -I '' lib/litani.py
+	sed -E -e 's/^RC *= *False/RC = True/g' -I '' lib/litani.py
+	git add lib/litani.py
+	major=$$(grep -e '^VERSION_MAJOR' lib/litani.py | head -n 1 | awk -F= '{print $$2}'); \
+	minor=$$(cat $(TMP)/rc-number); \
+	  git commit -m "Create version$${major}.$${minor} release candidate"
+
+$(TMP)/rc-number:
+	$(info --- Generating RC number)
+	printf "%d\n" \
+	  $$(( $$(grep -e '^VERSION_MINOR' lib/litani.py | awk '{print $$3}') + 1 )) \
+	  > $@
+	cat $@
+
+$(TMP)/current-release-number:
+	$(info --- Generating current release number)
+	printf "%d.%d.%d\n" \
+	  $$(grep -e '^VERSION_MAJOR' lib/litani.py | awk '{print $$3}') \
+	  $$(grep -e '^VERSION_MINOR' lib/litani.py | awk '{print $$3}') \
+	  $$(grep -e '^VERSION_PATCH' lib/litani.py | awk '{print $$3}') \
+	  > "$@"
+	cat $@
+
+merge-develop-release: $(TMP)/current-release-number
+	$(info --- Merging develop into release branch)
+	git checkout release
+	git merge \
+	  --no-ff \
+	  --message="Bump version to $$(cat $(TMP)/current-release-number)" \
+	  develop
+
+commit-changelog: $(TMP)/updated-changelog
+	$(info --- Turning off '-rc' suffix in version number)
+	sed -e 's/^RC *= *True/RC = False/g' -I '' lib/litani.py
+	$(info --- Adding changelog and updated version number)
+	cp $(TMP)/updated-changelog CHANGELOG
+	git add lib/litani.py CHANGELOG
+	git commit --amend --reuse-message=HEAD
+
+$(TMP)/updated-changelog: \
+	    $(TMP)/current-release-number \
+	    $(TMP)/user-changelog \
+	    $(TMP)/old-changelog
+	$(info --- Assembling new changelog from user input)
+	printf "                              CHANGELOG\n" > $@
+	printf '                              `````````\n\n' >> $@
+	printf "Version %s -- %s\n" \
+	  $$(cat $(TMP)/current-release-number) \
+	  $$(date +%Y-%m-%d) >> $@
+	printf -- "----------------------------\n" >> $@
+	printf "%s" \
+	  "$$(echo "$$(grep -ve '^#' $(TMP)/user-changelog)" | tac)" | tac >> $@
+	printf "\n\n" >> $@
+	cat $(TMP)/old-changelog >> $@
+
+$(TMP)/old-changelog:
+	$(info --- Dumping old changelog)
+	start_line=$$(\
+	  grep -ne '^Version ' CHANGELOG \
+	  | head -n 1 \
+	  | awk -F: '{print $$1}' \
+	); \
+	tail -n+$${start_line} CHANGELOG > $@
+
+$(TMP)/user-changelog: $(TMP)/commits.json
+	$(info --- Generating changelog for this release from feature list)
+	printf "" > $@
+	printf "%s\n" "# This will be the changelog entry for this release." >> $@
+	printf "%s\n" "# Lines beginning with '#' will be ignored." >> $@
+	printf "%s\n" "" >> $@
+	jq -r '[.[] | [ \
+	      "- " + .subject, \
+	      if (.body | length) > 1 \
+	      then "", (.body | .[] | if (. | length) == 0 then "" else "  " + . end) \
+	      else "" end \
+	    ] + [ \
+	      (if (.body | length) > 1 then "", "" else  "" end) \
+	    ] \
+	  ] | .[] | .[]' < $(TMP)/commits.json >> $@
+	vim +4 $@
+
+bump-version:
+	$(info --- Incrementing minor version number)
+	next_minor=$$(( \
+	  $$(grep -e '^VERSION_MINOR' lib/litani.py | awk '{print $$3}') + 1 \
+	)); \
+	sed -E -e 's/^VERSION_MINOR.+/VERSION_MINOR = $${next_minor}/g' \
+	  -I '' lib/litani.py
+
+tag-release: $(TMP)/current-release-number $(TMP)/tag-body
+	$(info --- Tagging release)
+	printf "Release %s\n\n" $$(cat $<) > $(TMP)/tag-file
+	cat $(TMP)/tag-body >> $(TMP)/tag-file
+	git tag --annotate --file=$(TMP)/tag-file $$(cat $<)
+
+$(TMP)/tag-body: $(TMP)/commits.json
+	$(info --- Generating tag body)
+	jq -r '.[] | "- " + .subject' > $@ < $<
+
+$(TMP)/commits.json:
+	$(info --- Generating JSON list of feature commits)
+	commit=HEAD; \
+	while true ; do \
+	  author=$$(git show --no-patch --pretty=format:%an "$${commit}"); \
+	  subject=$$(git show --no-patch --pretty=format:%s "$${commit}"); \
+	  body=$$(git show --no-patch --pretty=format:%b "$${commit}"); \
+	  last_rc=$$(printf "%s\n" "$${subject}" \
+	    | grep "Create version .\+ release candidate"); \
+	  if [ "$${last_rc}" ]; then \
+	    break; \
+	  fi ; \
+	  printf '%s\n%s\n%s' "$${author}" "$${subject}" "$${body}" \
+	    | jq --compact-output --raw-input --slurp \
+	        'split("\n") | {\
+	           "author": .[0], \
+	           "subject": .[1], \
+	           "body": .[2:] \
+	        }'; \
+	  commit="$${commit}~"; \
+	done \
+	| tr '\n' ',' | sed 's/,$$/]\n/; s/^{/[{/' | jq \
+	> $@

data/aws-crt-ffi/crt/s2n/tests/litani/templates/dashboard.jinja.html

@@ -52,13 +52,15 @@ h1 {
   font-size: small;
   color: #ec407a;
 }
+body {
+  color: #263238;
+}
 #content {
   max-width: 800px;
   margin-left: auto;
   margin-right: auto;
   padding-top: 2em;
   padding-bottom: 2em;
-  color: #263238;
   font-family: Helvetica, sans-serif;
 }
 p {
@@ -251,6 +253,42 @@ p {
   font-weight: bold;
 }
 
+.job-outputs-header {
+  color: #263238;
+}
+.job-output-content {
+  background-color: #eceff1;
+  padding: 0.3em 1em;
+  border-radius: 0.3em;
+  margin-bottom: 4em;
+}
+.job-output-title {
+  margin: 0.3em 0 1em;
+}
+.job-output-title a {
+  text-decoration: none;
+  color: #29b6f6;
+}
+.job-output-title a:link, .job-output-title a:visited {
+  color: #29b6f6;
+}
+.job-output-title a:hover, .job-output-title a:visited:hover {
+  color: #ec407a;
+  text-decoration: none;
+}
+.job-output-title a:active, .job-output-title a:visited:active {
+  color: #ffeb3b;
+  text-decoration: none;
+}
+.job-output-box {
+  margin-top: 0.4em;
+  margin-bottom: 0.2em;
+  padding: 1em;
+  border-radius: 0.5em;
+  overflow-x: auto;
+  overflow-y: auto;
+}
+
 @media (max-width: 640px){
   .pipeline-progress {
     width: 10em;
@@ -266,9 +304,6 @@ p {
   .status-icon-in-progress { fill: #ddd; }
   .status-icon-in-progress circle { stroke: #ddd; }
 
-  .pipeline-header {
-    color: #eceff1;
-  }
   .downloads-header {
     color: #eceff1;
   }
@@ -279,17 +314,22 @@ p {
   .downloads a {
     color: #29b6f6;
   }
-  .pipeline-row {
+  .job-outputs-header {
+    color: #eceff1;
+  }
+  .job-output-content {
+    background-color: #37474f;
+  }
+  .job-output-title {
     color: #eceff1;
+  }
+  .pipeline-row {
     background-color: #37474f;
   }
   body {
     color: #babdbe;
     background-color: #263238;
   }
-  p {
-    color: #babdbe;
-  }
   #subtitle {
     color: #fff;
   }
@@ -381,7 +421,7 @@ p {
     </div><!-- class="pipeline-row" -->
 
     {% for pipe in run["pipelines"] %}
-    <div class="pipeline-row">
+    <div class="pipeline-row" id="pipe_row_{{ pipe['name'] }}">
 
       <div class="pipeline-link">
             <svg height="16px" width="32px" class="pipeline-icon">
@@ -445,10 +485,36 @@ p {
     {% endfor %}{# pipe in run["pipelines"] #}
   </div><!-- id="pipeline-table" -->
 
+  {% if front_page_outputs %}
+    <div class="job-outputs">
+      <div class="job-outputs-header">
+        <h2>Job Outputs</h2>
+      </div>
+      {% for job_desc, job in front_page_outputs.items() %}
+        <div
+            class="job-output-content"
+            id="job_front_page_output_{{ job['wrapper_arguments']['job_id']}}">
+          <div class="job-output-title">
+            <h3>Output of job &quot;<a
+              href="pipelines/{{ job['wrapper_arguments']['pipeline_name'] }}/
+index.html#job-{{ job['wrapper_arguments']['job_id'] }}"
+            >{{ job_desc }}</a>&quot;:</h3>
+          </div>
+          <div class="job-output-box">
+            {% for line in job["stdout"] %}
+              {{ line.strip() }}
+            {%- endfor %}{# line in job["stdout"] #}
+          </div>
+        </div>
+      {% endfor %}{# job_desc, job in front_page_outputs.items() #}
+    </div>
+  {% endif %}{# front_page_outputs #}
 
   {% for title, svg_list in svgs.items() %}
     {% if svg_list %}
-      <h2 class="downloads-header">{{ title }}</h2>
+      <h2
+          class="downloads-header"
+          id="svg_{{ title }}">{{ title }}</h2>
       <div class="graphs">
       {% for svg in svg_list %}
         <div class="graph">
@@ -462,7 +528,7 @@ p {
   {% endfor -%}{# title, svg_list in svgs #}
 
 
-  <h2 class="downloads-header">Downloads</h2>
+  <h2 class="downloads-header" id="downloads">Downloads</h2>
   <div class="downloads">
     <ul>
       <li>
@@ -482,15 +548,12 @@ p {
     </ul>
   </div>
 
-  <div class="footer">
+  <div class="footer" id="footer">
     <div class="footer-cell">
       <p>
         Report generated with
         <a href="https://github.com/awslabs/aws-build-accumulator">Litani</a>
         {{ litani_version }}
-        {% if litani_hash is not none %}
-        (<code>{{ litani_hash }}</code>)
-        {% endif %}{# litani_hash is not none #}
       </p>
     </div><!-- class="footer-cell" -->
   </div><!-- class="footer" -->

data/aws-crt-ffi/crt/s2n/tests/litani/templates/pipeline.jinja.html

@@ -194,6 +194,14 @@ p {
   text-shadow: 0 0 2px #82ada944;
   font-weight: bold;
 }
+.literal-stdout {
+  margin-top: 0.4em;
+  margin-bottom: 0.2em;
+  padding: 1em;
+  border-radius: 0.5em;
+  overflow-x: auto;
+  overflow-y: auto;
+}
 .output-box {
   margin-top: 0.4em;
   margin-bottom: 0.2em;
@@ -773,12 +781,20 @@ a:visited:active {
 
 
           {% if job["stdout"] %}
-          <div class="output-box"><xmp>stdout:
-            {% for line in job["stdout"] %}
+            {% if job["wrapper_arguments"]["tags"] is not none and "literal-stdout" in job["wrapper_arguments"]["tags"] %}
+            <div class="literal-stdout">
+              {% for line in job["stdout"] %}
 {{ line.strip() }}
-            {%- endfor %}{# line in job["stdout"] #}
-            </xmp>
-          </div><!-- class="output-box" -->
+              {%- endfor %}{# line in job["stdout"] #}
+            </div><!-- class="literal-stdout" -->
+            {% else %}
+            <div class="output-box"><xmp>stdout:
+              {% for line in job["stdout"] %}
+{{ line.strip() }}
+              {%- endfor %}{# line in job["stdout"] #}
+              </xmp>
+            </div><!-- class="output-box" -->
+            {% endif %}{# is literal-stdout in tags #}
           {% endif %}{# job["stdout"] #}
 
           {% if job["stderr"] %}

data/aws-crt-ffi/crt/s2n/tests/litani/test/README

@@ -4,3 +4,18 @@
 The `run` script uses litani to run a variety of unit and system tests.
 The dashboard showing the output of the latest test run will always be
 symlinked from test/output/latest/html/index.html.
+
+# OPTIONS
+
+*--output-dir*
+	Litani will write all of its test output files for this run to this path
+
+*--fast*
+    Do not run tests with SLOW variable set to True
+
+## Writing Tests
+
+Each test is made up of 4 jobs: init, add-jobs, run-build, and check-run
+If --fast flag is passed, each job is given a timeout of 10 seconds.
+In the worst case, a test would take 40 seconds to run.
+For each test, SLOW is set to True if jobs fail to pass the above timeout.