ac-awssecrets 1.1.6 → 2.0.0

package/.acsemver.js

@@ -1,6 +1,6 @@
 module.exports = {
   repository: {
-    url: 'https://github.com/mmpro/ac-awssecrets'
+    url: 'https://github.com/admiralcloud/ac-awssecrets'
   },
   changelogFile: __dirname + '/CHANGELOG.md',
   sections: [

package/.eslintrc.js

@@ -1,4 +1,5 @@
 const config = {
+  root: true,
   'env': {
     'commonjs': true,
     'es6': true,
@@ -16,10 +17,12 @@ const config = {
   },
   globals: {
     describe: true,
-    it: true
+    it: true,
+    beforeEach: true,
+    afterEach: true
   },
   'parserOptions': {
-    'ecmaVersion': 2018
+    'ecmaVersion': 2022
 },
 }
 

package/.github/workflows/node.js.yml

@@ -0,0 +1,30 @@
+
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ develop ]
+  pull_request:
+    branches: [ develop ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: yarn install
+    - run: yarn run test

package/CHANGELOG.md

@@ -1,3 +1,46 @@
+<a name="2.0.0"></a>
+ 
+# [2.0.0](https://github.com/admiralcloud/ac-awssecrets/compare/v1.1.6..v2.0.0) (2023-02-26 11:45:48)
+
+
+### Feature
+
+* **App:** Complete rewrite | MP | [782aeddf4f9f6d815a19762c1c92dc138b369478](https://github.com/admiralcloud/ac-awssecrets/commit/782aeddf4f9f6d815a19762c1c92dc138b369478)    
+Using AWS IAM roles/profiles, use async/await  
+Related issues: [undefined/undefined#develop](undefined/browse/develop)
+### Bug Fix
+
+* **App:** Minor fixes | MP | [bc6c7cc832f98c939cf703e1b967bb7fdaa05c1f](https://github.com/admiralcloud/ac-awssecrets/commit/bc6c7cc832f98c939cf703e1b967bb7fdaa05c1f)    
+Improved error messages, make sure to get and set path based variables  
+Related issues: [undefined/undefined#develop](undefined/browse/develop)
+* **App:** Improved AWS profile handling | MP | [28fddd68778b7ad52b7a6dff3468d09655dde43e](https://github.com/admiralcloud/ac-awssecrets/commit/28fddd68778b7ad52b7a6dff3468d09655dde43e)    
+Allow profile as parameter for function call (instead of just env variable)  
+Related issues: [undefined/undefined#develop](undefined/browse/develop)
+### Tests
+
+* **App:** Added more tests | MP | [907289ea6e0b0406e5e82a2b7e7c84f0c8c9386f](https://github.com/admiralcloud/ac-awssecrets/commit/907289ea6e0b0406e5e82a2b7e7c84f0c8c9386f)    
+Added more tests  
+Related issues: [undefined/undefined#develop](undefined/browse/develop)
+* **App:** Add config for test | MP | [8d21f27a15a49bc9544d7ba387d2eca99c336af2](https://github.com/admiralcloud/ac-awssecrets/commit/8d21f27a15a49bc9544d7ba387d2eca99c336af2)    
+Add config for test  
+Related issues: [undefined/undefined#develop](undefined/browse/develop)
+### Documentation
+
+* **App:** Add badge for tests | MP | [93df1ae14f1daa77793010c0e24423ac13f64a89](https://github.com/admiralcloud/ac-awssecrets/commit/93df1ae14f1daa77793010c0e24423ac13f64a89)    
+Add badge for tests  
+Related issues: [undefined/undefined#develop](undefined/browse/develop)
+### Chores
+
+* **App:** Add coverage test with nyc | MP | [1cdc7330d4be1abcbcd728ab4bc4c772b5489468](https://github.com/admiralcloud/ac-awssecrets/commit/1cdc7330d4be1abcbcd728ab4bc4c772b5489468)    
+Use yarn coverage  
+Related issues: [undefined/undefined#develop](undefined/browse/develop)
+### Chores
+
+* **App:** Updated packages | MP | [c7e9f7965ac2e93b93282549dc86c7fc01b8f85c](https://github.com/admiralcloud/ac-awssecrets/commit/c7e9f7965ac2e93b93282549dc86c7fc01b8f85c)    
+Updated packages  
+Related issues: [undefined/undefined#develop](undefined/browse/develop)
+## BREAKING CHANGES
+* **App:** Not compatible with version 1 - please see README
 <a name="1.1.6"></a>
 
 ## [1.1.6](https://github.com/mmpro/ac-awssecrets/compare/v1.1.5..v1.1.6) (2022-04-20 11:48:54)
@@ -5,7 +48,7 @@
 
 ### Bug Fix
 
-* **App:** Updated packages | MP | [1ad4baa1414604b20b6b702a40527ba5930b7cfd](https://github.com/mmpro/ac-awssecrets/commit/1ad4baa1414604b20b6b702a40527ba5930b7cfd)    
+* **App:** Updated packages | MP | [1ad4baa1414604b20b6b702a40527ba5930b7cfd](https://github.com/admiralcloud/ac-awssecrets/commit/1ad4baa1414604b20b6b702a40527ba5930b7cfd)    
 Updated packages  
 Related issues: [undefined/undefined#master](undefined/browse/master)
 <a name="1.1.5"></a>

package/README.md

@@ -1,7 +1,135 @@
 # AC AWS Secrets
 Reads secrets from AWS secrets manager and adds them to the configuration of the embedding app.
 
-## Usage
+![example workflow](https://github.com/admiralcloud/ac-awssecrets/actions/workflows/node.js.yml/badge.svg)
+
+
+# Version 2 - BREAKING CHANGES
++ works with Node16 or higher
++ async/await - no callback!
++ uses AWS IAM roles or AWS IAM profiles instead of IAM credentials
+
+# Parameters
+|Parameter|Type|Required|Description|
+|---|---|---|---|
+|key|string|yes|the local variable name|
+|name|string|yes|the name of the AWS secret|
+|servers|bool|-|See below
+|valueHasJSON|bool|-|If true, some properties have JSON content (prefixed with JSON:)
+
+# Usage
+AWS secret is a JSON object. Those properties will be merged with local config properties based on the secret's name.
+
+## Secret
+
+### Store secret in AWS
+```
+Example secret
+// name: mySecret1
+{
+  prop1: 'abc',
+  prop2: 123,
+  prop3: 'JSON:{"jprop1": "abc}'
+}
+```
+
+### Configure a local variable, that should be enhanced with the secret
+```
+const config = {
+  key1: {},
+  otherKey: {
+    prop10: 'https://www.admiralcloud.com'
+  }
+}
+```
+
+### Fetch secrets
+```
+const secrets = [
+  { key: 'key1', name: 'mySecret1' } // key is the config var, name is the AWS secret name
+]
+await awsSecrets.loadSecrets({ secrets, config })
+
+// config will change  - key1 will be enhanced with AWS secret
+const config = {
+  key1: {
+    prop1: 'abc',
+    prop2: 123,
+    prop3: 'JSON:{"jprop1": "abc}'
+  },
+  otherKey: {
+    prop10: 'https://www.admiralcloud.com'
+  }
+}
+
+```
+
+## Multisecrets
+Use multisecrets if you want to add a number of additional secrets to be fetched. Usually it is used to fetch multiple objects for an array of objects:
+
+### Store multisecret in AWS
+```
+Example secret
+// name: mySecret2
+{
+  values: '["aws.key1", "aws.key2"]'
+}
+```
+
+### Store secrets in AWS 
+```
+// name: aws.key1
+{
+  accessKeyId: 'awsKey1',
+  secretAccessKey: 'awsSecret1'
+}
+
+// name: aws.key2
+{
+  accessKeyId: 'awsKey2',
+  secretAccessKey: 'awsSecret2'
+}
+```
+
+### Configure a local variable, that should be enhanced with the secret
+```
+const config = {
+  mySecret2: [],
+  otherKey: {
+    prop10: 'https://www.admiralcloud.com'
+  }
+}
+```
+
+### Fetch secrets
+```
+const multisecrets = [
+  { key: 'mySecret2', name: 'mySecret2' } // key is the config var, name is the AWS secret name
+]
+const secrets = []
+await awsSecrets.loadSecrets({ secrets, multisecrets, config })
+
+// config will change  - key1 will be enhanced with AWS secret
+const config = {
+  mySecret2: [
+    {
+      accessKeyId: 'awsKey1',
+      secretAccessKey: 'awsSecret1'
+    },
+    {
+      accessKeyId: 'awsKey2',
+      secretAccessKey: 'awsSecret2'
+    }
+  ]
+}
+
+```
+
+
+
+
+# VERSION 1 - OUTDATED
+## Usage 
 
 ### Simple example
 Lets assume we have the following configuration and secret
@@ -89,16 +217,9 @@ awsSecrets.loadSecrets(secretParams, (err, result) => {
 
 ```
 
-## Parameters
-+ aws - object with accessKeyId, secretAccessKey and region (IAM user must have permission to read the secrets)
-+ secrets - array of secrets to fetch
-+ config - the current config (secrets will be merged into it)
-+ environment - the current node environment (e.g. test, production, ... defaults to development)
-
 ## Links
 - [Website](https://www.admiralcloud.com/)
-- [Twitter (@admiralcloud)](https://twitter.com/admiralcloud)
 - [Facebook](https://www.facebook.com/MediaAssetManagement/)
 
 ## License
-[MIT License](https://opensource.org/licenses/MIT) Copyright © 2009-present, AdmiralCloud, Mark Poepping
+[MIT License](https://opensource.org/licenses/MIT) Copyright © 2009-present, AdmiralCloud AG, Mark Poepping

package/coverage/lcov-report/base.css

@@ -0,0 +1,224 @@
+body, html {
+  margin:0; padding: 0;
+  height: 100%;
+}
+body {
+    font-family: Helvetica Neue, Helvetica, Arial;
+    font-size: 14px;
+    color:#333;
+}
+.small { font-size: 12px; }
+*, *:after, *:before {
+  -webkit-box-sizing:border-box;
+     -moz-box-sizing:border-box;
+          box-sizing:border-box;
+  }
+h1 { font-size: 20px; margin: 0;}
+h2 { font-size: 14px; }
+pre {
+    font: 12px/1.4 Consolas, "Liberation Mono", Menlo, Courier, monospace;
+    margin: 0;
+    padding: 0;
+    -moz-tab-size: 2;
+    -o-tab-size:  2;
+    tab-size: 2;
+}
+a { color:#0074D9; text-decoration:none; }
+a:hover { text-decoration:underline; }
+.strong { font-weight: bold; }
+.space-top1 { padding: 10px 0 0 0; }
+.pad2y { padding: 20px 0; }
+.pad1y { padding: 10px 0; }
+.pad2x { padding: 0 20px; }
+.pad2 { padding: 20px; }
+.pad1 { padding: 10px; }
+.space-left2 { padding-left:55px; }
+.space-right2 { padding-right:20px; }
+.center { text-align:center; }
+.clearfix { display:block; }
+.clearfix:after {
+  content:'';
+  display:block;
+  height:0;
+  clear:both;
+  visibility:hidden;
+  }
+.fl { float: left; }
+@media only screen and (max-width:640px) {
+  .col3 { width:100%; max-width:100%; }
+  .hide-mobile { display:none!important; }
+}
+
+.quiet {
+  color: #7f7f7f;
+  color: rgba(0,0,0,0.5);
+}
+.quiet a { opacity: 0.7; }
+
+.fraction {
+  font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace;
+  font-size: 10px;
+  color: #555;
+  background: #E8E8E8;
+  padding: 4px 5px;
+  border-radius: 3px;
+  vertical-align: middle;
+}
+
+div.path a:link, div.path a:visited { color: #333; }
+table.coverage {
+  border-collapse: collapse;
+  margin: 10px 0 0 0;
+  padding: 0;
+}
+
+table.coverage td {
+  margin: 0;
+  padding: 0;
+  vertical-align: top;
+}
+table.coverage td.line-count {
+    text-align: right;
+    padding: 0 5px 0 20px;
+}
+table.coverage td.line-coverage {
+    text-align: right;
+    padding-right: 10px;
+    min-width:20px;
+}
+
+table.coverage td span.cline-any {
+    display: inline-block;
+    padding: 0 5px;
+    width: 100%;
+}
+.missing-if-branch {
+    display: inline-block;
+    margin-right: 5px;
+    border-radius: 3px;
+    position: relative;
+    padding: 0 4px;
+    background: #333;
+    color: yellow;
+}
+
+.skip-if-branch {
+    display: none;
+    margin-right: 10px;
+    position: relative;
+    padding: 0 4px;
+    background: #ccc;
+    color: white;
+}
+.missing-if-branch .typ, .skip-if-branch .typ {
+    color: inherit !important;
+}
+.coverage-summary {
+  border-collapse: collapse;
+  width: 100%;
+}
+.coverage-summary tr { border-bottom: 1px solid #bbb; }
+.keyline-all { border: 1px solid #ddd; }
+.coverage-summary td, .coverage-summary th { padding: 10px; }
+.coverage-summary tbody { border: 1px solid #bbb; }
+.coverage-summary td { border-right: 1px solid #bbb; }
+.coverage-summary td:last-child { border-right: none; }
+.coverage-summary th {
+  text-align: left;
+  font-weight: normal;
+  white-space: nowrap;
+}
+.coverage-summary th.file { border-right: none !important; }
+.coverage-summary th.pct { }
+.coverage-summary th.pic,
+.coverage-summary th.abs,
+.coverage-summary td.pct,
+.coverage-summary td.abs { text-align: right; }
+.coverage-summary td.file { white-space: nowrap;  }
+.coverage-summary td.pic { min-width: 120px !important;  }
+.coverage-summary tfoot td { }
+
+.coverage-summary .sorter {
+    height: 10px;
+    width: 7px;
+    display: inline-block;
+    margin-left: 0.5em;
+    background: url(sort-arrow-sprite.png) no-repeat scroll 0 0 transparent;
+}
+.coverage-summary .sorted .sorter {
+    background-position: 0 -20px;
+}
+.coverage-summary .sorted-desc .sorter {
+    background-position: 0 -10px;
+}
+.status-line {  height: 10px; }
+/* yellow */
+.cbranch-no { background: yellow !important; color: #111; }
+/* dark red */
+.red.solid, .status-line.low, .low .cover-fill { background:#C21F39 }
+.low .chart { border:1px solid #C21F39 }
+.highlighted,
+.highlighted .cstat-no, .highlighted .fstat-no, .highlighted .cbranch-no{
+  background: #C21F39 !important;
+}
+/* medium red */
+.cstat-no, .fstat-no, .cbranch-no, .cbranch-no { background:#F6C6CE }
+/* light red */
+.low, .cline-no { background:#FCE1E5 }
+/* light green */
+.high, .cline-yes { background:rgb(230,245,208) }
+/* medium green */
+.cstat-yes { background:rgb(161,215,106) }
+/* dark green */
+.status-line.high, .high .cover-fill { background:rgb(77,146,33) }
+.high .chart { border:1px solid rgb(77,146,33) }
+/* dark yellow (gold) */
+.status-line.medium, .medium .cover-fill { background: #f9cd0b; }
+.medium .chart { border:1px solid #f9cd0b; }
+/* light yellow */
+.medium { background: #fff4c2; }
+
+.cstat-skip { background: #ddd; color: #111; }
+.fstat-skip { background: #ddd; color: #111 !important; }
+.cbranch-skip { background: #ddd !important; color: #111; }
+
+span.cline-neutral { background: #eaeaea; }
+
+.coverage-summary td.empty {
+    opacity: .5;
+    padding-top: 4px;
+    padding-bottom: 4px;
+    line-height: 1;
+    color: #888;
+}
+
+.cover-fill, .cover-empty {
+  display:inline-block;
+  height: 12px;
+}
+.chart {
+  line-height: 0;
+}
+.cover-empty {
+    background: white;
+}
+.cover-full {
+    border-right: none !important;
+}
+pre.prettyprint {
+    border: none !important;
+    padding: 0 !important;
+    margin: 0 !important;
+}
+.com { color: #999 !important; }
+.ignore-none { color: #999; font-weight: normal; }
+
+.wrapper {
+  min-height: 100%;
+  height: auto !important;
+  height: 100%;
+  margin: 0 auto -48px;
+}
+.footer, .push {
+  height: 48px;
+}

package/coverage/lcov-report/block-navigation.js

@@ -0,0 +1,87 @@
+/* eslint-disable */
+var jumpToCode = (function init() {
+    // Classes of code we would like to highlight in the file view
+    var missingCoverageClasses = ['.cbranch-no', '.cstat-no', '.fstat-no'];
+
+    // Elements to highlight in the file listing view
+    var fileListingElements = ['td.pct.low'];
+
+    // We don't want to select elements that are direct descendants of another match
+    var notSelector = ':not(' + missingCoverageClasses.join('):not(') + ') > '; // becomes `:not(a):not(b) > `
+
+    // Selecter that finds elements on the page to which we can jump
+    var selector =
+        fileListingElements.join(', ') +
+        ', ' +
+        notSelector +
+        missingCoverageClasses.join(', ' + notSelector); // becomes `:not(a):not(b) > a, :not(a):not(b) > b`
+
+    // The NodeList of matching elements
+    var missingCoverageElements = document.querySelectorAll(selector);
+
+    var currentIndex;
+
+    function toggleClass(index) {
+        missingCoverageElements
+            .item(currentIndex)
+            .classList.remove('highlighted');
+        missingCoverageElements.item(index).classList.add('highlighted');
+    }
+
+    function makeCurrent(index) {
+        toggleClass(index);
+        currentIndex = index;
+        missingCoverageElements.item(index).scrollIntoView({
+            behavior: 'smooth',
+            block: 'center',
+            inline: 'center'
+        });
+    }
+
+    function goToPrevious() {
+        var nextIndex = 0;
+        if (typeof currentIndex !== 'number' || currentIndex === 0) {
+            nextIndex = missingCoverageElements.length - 1;
+        } else if (missingCoverageElements.length > 1) {
+            nextIndex = currentIndex - 1;
+        }
+
+        makeCurrent(nextIndex);
+    }
+
+    function goToNext() {
+        var nextIndex = 0;
+
+        if (
+            typeof currentIndex === 'number' &&
+            currentIndex < missingCoverageElements.length - 1
+        ) {
+            nextIndex = currentIndex + 1;
+        }
+
+        makeCurrent(nextIndex);
+    }
+
+    return function jump(event) {
+        if (
+            document.getElementById('fileSearch') === document.activeElement &&
+            document.activeElement != null
+        ) {
+            // if we're currently focused on the search input, we don't want to navigate
+            return;
+        }
+
+        switch (event.which) {
+            case 78: // n
+            case 74: // j
+                goToNext();
+                break;
+            case 66: // b
+            case 75: // k
+            case 80: // p
+                goToPrevious();
+                break;
+        }
+    };
+})();
+window.addEventListener('keydown', jumpToCode);

package/coverage/lcov-report/index.html

@@ -0,0 +1,116 @@
+
+<!doctype html>
+<html lang="en">
+
+<head>
+    <title>Code coverage report for All files</title>
+    <meta charset="utf-8" />
+    <link rel="stylesheet" href="prettify.css" />
+    <link rel="stylesheet" href="base.css" />
+    <link rel="shortcut icon" type="image/x-icon" href="favicon.png" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <style type='text/css'>
+        .coverage-summary .sorter {
+            background-image: url(sort-arrow-sprite.png);
+        }
+    </style>
+</head>
+    
+<body>
+<div class='wrapper'>
+    <div class='pad1'>
+        <h1>All files</h1>
+        <div class='clearfix'>
+            
+            <div class='fl pad1y space-right2'>
+                <span class="strong">84.33% </span>
+                <span class="quiet">Statements</span>
+                <span class='fraction'>70/83</span>
+            </div>
+        
+            
+            <div class='fl pad1y space-right2'>
+                <span class="strong">68.85% </span>
+                <span class="quiet">Branches</span>
+                <span class='fraction'>42/61</span>
+            </div>
+        
+            
+            <div class='fl pad1y space-right2'>
+                <span class="strong">92.85% </span>
+                <span class="quiet">Functions</span>
+                <span class='fraction'>13/14</span>
+            </div>
+        
+            
+            <div class='fl pad1y space-right2'>
+                <span class="strong">85.52% </span>
+                <span class="quiet">Lines</span>
+                <span class='fraction'>65/76</span>
+            </div>
+        
+            
+        </div>
+        <p class="quiet">
+            Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
+        </p>
+        <template id="filterTemplate">
+            <div class="quiet">
+                Filter:
+                <input oninput="onInput()" type="search" id="fileSearch">
+            </div>
+        </template>
+    </div>
+    <div class='status-line high'></div>
+    <div class="pad1">
+<table class="coverage-summary">
+<thead>
+<tr>
+   <th data-col="file" data-fmt="html" data-html="true" class="file">File</th>
+   <th data-col="pic" data-type="number" data-fmt="html" data-html="true" class="pic"></th>
+   <th data-col="statements" data-type="number" data-fmt="pct" class="pct">Statements</th>
+   <th data-col="statements_raw" data-type="number" data-fmt="html" class="abs"></th>
+   <th data-col="branches" data-type="number" data-fmt="pct" class="pct">Branches</th>
+   <th data-col="branches_raw" data-type="number" data-fmt="html" class="abs"></th>
+   <th data-col="functions" data-type="number" data-fmt="pct" class="pct">Functions</th>
+   <th data-col="functions_raw" data-type="number" data-fmt="html" class="abs"></th>
+   <th data-col="lines" data-type="number" data-fmt="pct" class="pct">Lines</th>
+   <th data-col="lines_raw" data-type="number" data-fmt="html" class="abs"></th>
+</tr>
+</thead>
+<tbody><tr>
+	<td class="file high" data-value="index.js"><a href="index.js.html">index.js</a></td>
+	<td data-value="84.33" class="pic high">
+	<div class="chart"><div class="cover-fill" style="width: 84%"></div><div class="cover-empty" style="width: 16%"></div></div>
+	</td>
+	<td data-value="84.33" class="pct high">84.33%</td>
+	<td data-value="83" class="abs high">70/83</td>
+	<td data-value="68.85" class="pct medium">68.85%</td>
+	<td data-value="61" class="abs medium">42/61</td>
+	<td data-value="92.85" class="pct high">92.85%</td>
+	<td data-value="14" class="abs high">13/14</td>
+	<td data-value="85.52" class="pct high">85.52%</td>
+	<td data-value="76" class="abs high">65/76</td>
+	</tr>
+
+</tbody>
+</table>
+</div>
+                <div class='push'></div><!-- for sticky footer -->
+            </div><!-- /wrapper -->
+            <div class='footer quiet pad2 space-top1 center small'>
+                Code coverage generated by
+                <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
+                at 2023-02-25T07:46:45.054Z
+            </div>
+        <script src="prettify.js"></script>
+        <script>
+            window.onload = function () {
+                prettyPrint();
+            };
+        </script>
+        <script src="sorter.js"></script>
+        <script src="block-navigation.js"></script>
+    </body>
+</html>
+