Add reports for CI and local compilation. Will report contract size changes and and trade gas consumption changes. (#947)

Co-authored-by: Ilan Doron <[email protected]>

Author: ductm54

.gitignore

@@ -41,3 +41,5 @@ jspm_packages
 
 # OS file
 .DS_Store
+
+report

.travis.yml

@@ -1,5 +1,3 @@
-sudo: required
-
 language: node_js
 node_js:
   - 10
@@ -13,7 +11,7 @@ env:
   global:
     - COVERAGE_BRANCH=Katalyst
 
-matrix:
+jobs:
   include:
     - env:
         - TEST_PART: Sol6
@@ -23,14 +21,27 @@ matrix:
 install:
   - npm ci
 
-before script:
+before_script:
   - npx solhint contracts/sol6/**/*.sol
 
 script:
   - ./cmp.sh
   - .travis/test-part.sh
+  - .travis/report.sh
 
 deploy:
+  - provider: s3
+    access_key_id: $AWS_ACCESS_KEY_ID
+    secret_access_key: $AWS_SECRET_ACCESS_KEY
+    bucket: katalyst-coverage.knstats.com
+    region: ap-southeast-1
+    acl: public_read
+    local_dir: report
+    upload_dir: report
+    skip_cleanup: true
+    on:
+      all_branches: true
+      condition: $TEST_PART = Sol6
   - provider: s3
     access_key_id: $AWS_ACCESS_KEY_ID
     secret_access_key: $AWS_SECRET_ACCESS_KEY

.travis/report.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+node contractSizeReport.js $TRAVIS_PULL_REQUEST_BRANCH
+node gasUsedReport.js $TRAVIS_PULL_REQUEST_BRANCH

cmp.sh

@@ -3,3 +3,4 @@ export NODE_OPTIONS=--max-old-space-size=4096
 npx buidler compile
 npx buidler compile --config buidlerConfigSol5.js
 npx buidler compile --config buidlerConfigSol4.js
+node contractSizeReport.js

cmpSol6.sh

@@ -1,2 +1,3 @@
 #!/bin/sh
 npx buidler compile
+node contractSizeReport.js

contractSizeReport.js

@@ -0,0 +1,104 @@
+'use strict';
+const fs = require('fs');
+const util = require('util');
+const got = require('got');
+const yargs = require('yargs');
+
+let path = 'artifacts';
+
+const readdir = util.promisify(fs.readdir);
+
+let argv = yargs.default('branch', 'Katalyst').alias('b', 'branch').argv;
+
+async function generateCodeSizeReport() {
+  let result = {};
+  let fileNames = await readdir(path);
+  for (let i = 0; i < fileNames.length; i++) {
+    let fileName = fileNames[i];
+    let rawData = fs.readFileSync(path + '/' + fileName);
+    let contractData = JSON.parse(rawData);
+    let codeSize = contractData.deployedBytecode.length / 2 - 1;
+    if (codeSize > 0) {
+      result[fileName] = codeSize;
+    }
+  }
+  return result;
+}
+
+async function writeReport(report) {
+  let jsonContent = JSON.stringify(report, null, '\t');
+  let reportDir = 'report';
+  if (process.env.TRAVIS_BRANCH !== undefined) {
+    reportDir = `report/${process.env.TRAVIS_BRANCH}`;
+  }
+  let reportFile = `${reportDir}/contractSize.json`;
+  if (!fs.existsSync(reportDir)) {
+    fs.mkdirSync(reportDir, {recursive: true});
+  }
+  fs.writeFile(reportFile, jsonContent, 'utf8', function (err) {
+    if (err) {
+      console.log('An error occured while writing JSON Object to File.');
+      return console.log(err);
+    }
+  });
+}
+
+async function getRemoteReport() {
+  try {
+    const url = `http://katalyst-coverage.knstats.com/report/${argv.branch}/contractSize.json`;
+    return await got(url).json();
+  } catch (error) {
+    // console.log(error);
+    return false;
+  }
+}
+
+async function compareContractSize() {
+  let contractSizeReport = await generateCodeSizeReport();
+  await writeReport(contractSizeReport);
+  let remoteReport = await getRemoteReport();
+  if (!remoteReport) {
+    console.log(`Could not get report for ${argv.branch}`);
+    console.log("Current contract size report");
+    console.table(contractSizeReport);
+    return false;
+  }
+  let diffDict = {};
+  for (let contract in contractSizeReport) {
+    if (contract in remoteReport) {
+      let baseBranchSize = remoteReport[contract];
+      let currentSize = contractSizeReport[contract];
+      let diff = currentSize - baseBranchSize;
+      if (diff != 0) {
+        diffDict[contract] = {
+          [argv.branch]: baseBranchSize,
+          current: currentSize,
+          diff: diff,
+        };
+      }
+    }
+  }
+  for (let contract in remoteReport) {
+    if (contract in remoteReport && !(contract in diffDict)) {
+      let baseBranchSize = remoteReport[contract];
+      let currentSize = contractSizeReport[contract];
+      let diff = currentSize - baseBranchSize;
+      if (diff != 0) {
+        diffDict[contract] = {
+          [argv.branch]: baseBranchSize,
+          current: currentSize,
+          diff: diff,
+        };
+      }
+    }
+  }
+  if (Object.keys(diffDict).length > 0) {
+    console.log(`There is change in following contract size with ${argv.branch}`);
+    console.table(diffDict);
+  } else {
+    console.log("Contract size didn't change");
+    console.table(contractSizeReport);
+  }
+}
+
+compareContractSize();

gasUsedReport.js

@@ -0,0 +1,74 @@
+'use strict';
+const fs = require('fs');
+const util = require('util');
+const got = require('got');
+const yargs = require('yargs');
+
+let argv = yargs.default('branch', 'Katalyst').alias('b', 'branch').argv;
+
+async function getRemoteReport() {
+  try {
+    const url = `http://katalyst-coverage.knstats.com/report/${argv.branch}/gasUsed.json`;
+    return await got(url).json();
+  } catch (error) {
+    // console.log(error);
+    return false;
+  }
+}
+
+async function getLocalReport() {
+  let reportFile = `report/gasUsed.json`;
+  if (process.env.TRAVIS_BRANCH !== undefined) {
+    reportFile = `report/${process.env.TRAVIS_BRANCH}/gasUsed.json`;
+  }
+  let report = JSON.parse(fs.readFileSync(reportFile, 'utf8'));
+  return report
+}
+
+async function compareGasConsumtion() {
+  let localReport = await getLocalReport();
+  let remoteReport = await getRemoteReport();
+  if (!remoteReport) {
+    console.log(`Could not get report for ${argv.branch}. Current report`);
+    console.table(localReport);
+    return false;
+  }
+  let diffDict = {};
+  for (let testCase in localReport) {
+    if (testCase in remoteReport) {
+      let baseBranchSize = remoteReport[testCase];
+      let currentSize = localReport[testCase];
+      let diff = currentSize - baseBranchSize;
+      if (diff != 0) {
+        diffDict[testCase] = {
+          [argv.branch]: baseBranchSize,
+          current: currentSize,
+          diff: diff,
+        };
+      }
+    }
+  }
+  for (let testCase in remoteReport) {
+    if (testCase in remoteReport && !(testCase in diffDict)) {
+      let baseBranchSize = remoteReport[testCase];
+      let currentSize = localReport[testCase];
+      let diff = currentSize - baseBranchSize;
+      if (diff != 0) {
+        diffDict[testCase] = {
+          [argv.branch]: baseBranchSize,
+          current: currentSize,
+          diff: diff,
+        };
+      }
+    }
+  }
+  if (Object.keys(diffDict).length > 0) {
+    console.log(`There is change in following gas report with ${argv.branch}`);
+    console.table(diffDict);
+  } else {
+    console.log("Gas report didn't change");
+    console.table(localReport);
+  }
+}
+
+compareGasConsumtion();