From e8017703453e4bfa72e71bb42dec4e9459395d89 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Kamil=20=C5=9Aliwak?= <kamil.sliwak@codepoets.it>
Date: Wed, 22 Dec 2021 17:45:20 +0100
Subject: [PATCH] Benchmark report collector job + summary

---
 .circleci/config.yml                          | 30 ++++++++++
 scripts/externalTests/merge_benchmarks.sh     | 60 +++++++++++++++++++
 scripts/externalTests/summarize_benchmarks.sh | 53 ++++++++++++++++
 3 files changed, 143 insertions(+)
 create mode 100755 scripts/externalTests/merge_benchmarks.sh
 create mode 100755 scripts/externalTests/summarize_benchmarks.sh

diff --git a/.circleci/config.yml b/.circleci/config.yml
index bb4dc9c3b..7c3460ce4 100644
--- a/.circleci/config.yml
+++ b/.circleci/config.yml
@@ -1205,6 +1205,23 @@ jobs:
             - reports/externalTests/
       - gitter_notify_failure_unless_pr
 
+  c_ext_benchmarks:
+    <<: *base_node_latest_small
+    steps:
+      - checkout
+      - attach_workspace:
+          at: .
+      - run:
+          name: Combine benchmark reports
+          command: cat reports/externalTests/benchmark-*.json | scripts/externalTests/merge_benchmarks.sh > reports/externalTests/all-benchmarks.json
+      - run:
+          name: Summarize reports
+          command: cat reports/externalTests/all-benchmarks.json | scripts/externalTests/summarize_benchmarks.sh > reports/externalTests/summarized-benchmarks.json
+      - store_artifacts:
+          path: reports/externalTests/all-benchmarks.json
+      - store_artifacts:
+          path: reports/externalTests/summarized-benchmarks.json
+
   b_win: &b_win
     <<: *base_win_powershell_large
     steps:
@@ -1451,6 +1468,19 @@ workflows:
       - t_ems_ext: *job_native_test_ext_bleeps
       - t_ems_ext: *job_native_test_ext_pool_together
 
+      - c_ext_benchmarks:
+          <<: *workflow_trigger_on_tags
+          requires:
+            - t_ems_compile_ext_colony
+            - t_native_compile_ext_gnosis
+            - t_native_test_ext_gnosis_v2
+            - t_native_test_ext_zeppelin
+            - t_native_test_ext_ens
+            - t_native_test_ext_trident
+            - t_native_test_ext_euler
+            - t_native_test_ext_yield_liquidator
+            - t_native_test_ext_bleeps
+
       # Windows build and tests
       - b_win: *workflow_trigger_on_tags
       - b_win_release: *workflow_trigger_on_tags
diff --git a/scripts/externalTests/merge_benchmarks.sh b/scripts/externalTests/merge_benchmarks.sh
new file mode 100755
index 000000000..3e2d7318c
--- /dev/null
+++ b/scripts/externalTests/merge_benchmarks.sh
@@ -0,0 +1,60 @@
+#!/usr/bin/env bash
+
+# ------------------------------------------------------------------------------
+# Reads multiple individual benchmark reports produced by scripts from
+# test/externalTests/ from standard input and creates a combined report.
+#
+# Usage:
+#    <script name>.sh < <CONCATENATED_REPORTS>
+#
+# CONCATENATED_REPORTS: JSON report files concatenated into a single stream (e.g. using cat).
+#
+# Example:
+#    cat reports/externalTests/benchmark-*.json | <script name>.sh
+# ------------------------------------------------------------------------------
+# This file is part of solidity.
+#
+# solidity is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# solidity is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with solidity.  If not, see <http://www.gnu.org/licenses/>
+#
+# (c) 2021 solidity contributors.
+#------------------------------------------------------------------------------
+
+set -euo pipefail
+
+# We expect a series of dicts of the form {"<project>": {"<preset>": {...}}}.
+# Unfortunately jq's built-in `add` filter can't handle nested dicts and
+# would just overwrite values sharing a project name instead of merging them.
+
+# This is done by first grouping the dicts into an array of the form
+# [
+#     [{"key": "<project1>", "value": {"<preset1>": {...}}}, {"key": "<project1>", "value": {"<preset2>": {...}}, ...],
+#     [{"key": "<project2>", "value": {"<preset1>": {...}}}, {"key": "<project2>", "value": {"<preset2>": {...}}, ...],
+#     ...
+# ]
+# and then using reduce() on each group sharing the same project name to convert it into a
+# dict having preset names as keys.
+jq --slurp  --indent 4 --sort-keys '
+    map(to_entries[]) |
+    group_by(.key) |
+    map({
+        (.[0].key): (
+            reduce (.[].value | to_entries[]) as {$key, $value} (
+                {}; . + {
+                    ($key): $value
+                }
+            )
+        )
+    }) |
+    add
+'
diff --git a/scripts/externalTests/summarize_benchmarks.sh b/scripts/externalTests/summarize_benchmarks.sh
new file mode 100755
index 000000000..1b84800b2
--- /dev/null
+++ b/scripts/externalTests/summarize_benchmarks.sh
@@ -0,0 +1,53 @@
+#!/usr/bin/env bash
+
+# ------------------------------------------------------------------------------
+# Reads a combined benchmark report from standard input and outputs an abbreviated
+# report containing only totals. Can handle individual reports coming directly
+# from scripts in test/externalTests/ as well as combined report from merge_benchmarks.sh.
+#
+# Usage:
+#    <script name>.sh < <CONCATENATED_REPORTS>
+#
+# CONCATENATED_REPORTS: JSON report files concatenated into a single stream (e.g. using cat).
+#
+# Example:
+#    cat reports/externalTests/benchmark-*.json | <script name>.sh
+# ------------------------------------------------------------------------------
+# This file is part of solidity.
+#
+# solidity is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# solidity is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with solidity.  If not, see <http://www.gnu.org/licenses/>
+#
+# (c) 2021 solidity contributors.
+#------------------------------------------------------------------------------
+
+set -euo pipefail
+
+REPO_ROOT=$(realpath "$(dirname "$0")/../..")
+
+# Iterates over presets in a dict of the form {"<project>": {"<preset>": {...}}} and for each
+# one preserves only the few keys with totals that we want to see in the summary.
+exec "${REPO_ROOT}/scripts/externalTests/merge_benchmarks.sh" | jq --indent 4 --sort-keys '
+    with_entries({
+        key: .key,
+        value: .value | with_entries({
+            key: .key,
+            value: {
+                bytecode_size: .value.total_bytecode_size,
+                method_gas: .value.gas.total_method_gas,
+                deployment_gas: .value.gas.total_deployment_gas,
+                version: .value.project.version
+            }
+        })
+    })
+'