feat(namespace): handle request on vault namespace (#5)

* feat(namespace): handle request on vault namespace

.github/workflows/build.yml

@@ -1,26 +1,7 @@
-name: Test
-
 on: [push]
 
 jobs:
-  unit:
+  test:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v1
-    - name: Use Node.js 10.x
-      uses: actions/setup-node@v1
-      with:
-        node-version: 10.x
-    - name: npm install and test
-      run: |
-        npm ci
-        npm test
-      env:
-        CI: true
-
-  integration:
     runs-on: ubuntu-latest
 
     services:
@@ -40,11 +21,51 @@ jobs:
         node-version: 10.x
     - name: npm install
       run: npm ci
+    - name: npm build
+      run: npm run build
+    - name: npm run test
+      run: npm run test
+      env:
+        CI: true
     - name: npm run test:integration
       run: npm run test:integration
       env:
         VAULT_HOST: localhost
         VAULT_PORT: ${{ job.services.vault.ports[8200] }}
+        CI: true
+
+  test-ent:
+    runs-on: ubuntu-latest
+
+    services:
+      vault:
+        image: hashicorp/vault-enterprise:1.3.0_ent
+        ports:
+          - 8200/tcp
+        env:
+          VAULT_DEV_ROOT_TOKEN_ID: testtoken
+        options: --cap-add=IPC_LOCK
+
+    steps:
+      - uses: actions/checkout@v1
+      - name: Use Node.js 10.x
+        uses: actions/setup-node@v1
+        with:
+          node-version: 10.x
+      - name: npm install
+        run: npm ci
+      - name: npm build
+        run: npm run build
+      - name: npm run test
+        run: npm run test
+        env:
+          CI: true
+      - name: npm run test:integration-ent
+        run: npm run test:integration-ent
+        env:
+          VAULT_HOST: localhost
+          VAULT_PORT: ${{ job.services.vault.ports[8200] }}
+          CI: true
 
   e2e:
     runs-on: ubuntu-latest
@@ -66,6 +87,8 @@ jobs:
         node-version: 10.x
     - name: npm install
       run: npm ci
+    - name: npm build
+      run: npm run build
     - name: setup vault
       run: node ./e2e/setup.js
       env:
@@ -83,5 +106,20 @@ jobs:
     - name: verify
       run: npm run test:e2e
 
-  
+  publish:
+    runs-on: ubuntu-latest
+    needs: [test, e2e]
+    steps:
+    - uses: actions/checkout@v1
+    - name: Use Node.js 10.x
+      uses: actions/setup-node@v1
+      with:
+        node-version: 10.x
+    - name: npm install
+      run: npm ci
+    - name: release
+      if: success() && endsWith(github.ref, 'master')
+      run: npx semantic-release
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 

README.md

@@ -1,6 +1,6 @@
 # vault-action
 
-A helper action for easily pulling secrets from the v2 K/V backend of vault.
+A helper action for easily pulling secrets from the default v2 K/V backend of vault.
 
 ## Example Usage
 
@@ -68,11 +68,30 @@ This action can take multi-line input, so say you had your AWS keys stored in a
 
 ```yaml
 with:
-    keys: |
+    secrets: |
         ci/aws accessKey | AWS_ACCESS_KEY_ID ;
         ci/aws secretKey | AWS_SECRET_ACCESS_KEY
 ```
 
+### Namespace
+
+This action could be use with namespace Vault Enterprise feature. You can specify namespace in request : 
+
+```yaml
+steps:
+    # ...
+    - name: Import Secrets
+      uses: RichiCoder1/vault-action
+      with:
+        url: https://vault-enterprise.mycompany.com:8200
+        token: ${{ secrets.VaultToken }}
+        namespace: ns1
+        secrets: |
+            ci/aws accessKey | AWS_ACCESS_KEY_ID ;
+            ci/aws secretKey | AWS_SECRET_ACCESS_KEY ;
+            ci npm_token
+```
+
 ## Masking
 
 This action uses Github Action's built in masking, so all variables will automatically be masked if printed to the console or to logs.

action.js

@@ -5,17 +5,23 @@ const got = require('got');
 async function exportSecrets() {
     const vaultUrl = core.getInput('url', { required: true });
     const vaultToken = core.getInput('token', { required: true });
+    const vaultNamespace = core.getInput('namespace', { required: false });
 
     const secretsInput = core.getInput('secrets', { required: true });
     const secrets = parseSecretsInput(secretsInput);
 
     for (const secret of secrets) {
         const { secretPath, outputName, secretKey } = secret;
-        const result = await got(`${vaultUrl}/v1/secret/data/${secretPath}`, {
+        const requestOptions = {
             headers: {
                 'X-Vault-Token': vaultToken
-            }
+            }};
-        });
+
+        if (vaultNamespace != null){
+            requestOptions.headers["X-Vault-Namespace"] = vaultNamespace
+        }
+
+        const result = await got(`${vaultUrl}/v1/secret/data/${secretPath}`, requestOptions);
 
         const parsedResponse = JSON.parse(result.body);
         const vaultKeyData = parsedResponse.data;

action.yml

@@ -1,4 +1,4 @@
-name: 'Vault'
+name: 'Vault Secrets'
 description: 'A Github Action that allows you to consume the v2 K/V backend of HashiCorp Vault as secure environment variables'
 inputs:
   url:
@@ -10,6 +10,12 @@ inputs:
   secrets:
     description: 'A semicolon-separated list of secrets to retrieve. These will automatically be converted to environmental variable keys. See README for more details'
     required: true
+  namespace:
+    description: 'The Vault namespace from which to query secrets. Vault Enterprise only, unset by default'
+    required: false
 runs:
   using: 'node12'
-  main: 'index.js'
+  main: 'dist/index.js'
+branding:
+  icon: 'unlock'
+  color: 'gray-dark'

docker-compose.yml

@@ -0,0 +1,12 @@
+# Start vault server locally
+# You can run integration tests against server by running
+#  `VAULT_HOST=localhost VAULT_PORT=8200 CI=true npm run test:integration-ent`
+version: "3.0"
+services:
+  vault:
+    image: hashicorp/vault-enterprise:1.3.0_ent
+    environment:
+      VAULT_DEV_ROOT_TOKEN_ID: testtoken
+    ports:
+      - 8200:8200
+    privileged: true

integration-ent/integration.test.js

@@ -0,0 +1,131 @@
+jest.mock('@actions/core');
+jest.mock('@actions/core/lib/command');
+const core = require('@actions/core');
+
+const got = require('got');
+const { when } = require('jest-when');
+
+const { exportSecrets } = require('../action');
+
+describe('integration', () => {
+
+    beforeAll(async () => {
+        // Verify Connection
+        await got(`http://${process.env.VAULT_HOST}:${process.env.VAULT_PORT}/v1/secret/config`, {
+            headers: {
+                'X-Vault-Token': 'testtoken',
+            },
+        });
+
+        // Create namespace
+        await got(`http://${process.env.VAULT_HOST}:${process.env.VAULT_PORT}/v1/sys/namespaces/ns1`, {
+            method: 'POST',
+            headers: {
+                'X-Vault-Token': 'testtoken',
+            },
+            json: true,
+        });
+
+        // Enable secret engine
+        await got(`http://${process.env.VAULT_HOST}:${process.env.VAULT_PORT}/v1/sys/mounts/secret`, {
+            method: 'POST',
+            headers: {
+                'X-Vault-Token': 'testtoken',
+                'X-Vault-Namespace': 'ns1',
+            },
+            body: {"path":"secret","type":"kv","config":{},"options":{"version":2},"generate_signing_key":true},
+            json: true,
+        });
+
+        await got(`http://${process.env.VAULT_HOST}:${process.env.VAULT_PORT}/v1/secret/data/test`, {
+            method: 'POST',
+            headers: {
+                'X-Vault-Token': 'testtoken',
+                'X-Vault-Namespace': 'ns1',
+            },
+            body: {
+                data: {
+                    secret: "SUPERSECRET_IN_NAMESPACE",
+                },
+            },
+            json: true,
+        });
+
+        await got(`http://${process.env.VAULT_HOST}:${process.env.VAULT_PORT}/v1/secret/data/nested/test`, {
+            method: 'POST',
+            headers: {
+                'X-Vault-Token': 'testtoken',
+                'X-Vault-Namespace': 'ns1',
+            },
+            body: {
+                data: {
+                    otherSecret: "OTHERSUPERSECRET_IN_NAMESPACE",
+                },
+            },
+            json: true,
+        });
+
+
+
+    })
+    beforeEach(() => {
+        jest.resetAllMocks();
+
+        when(core.getInput)
+            .calledWith('url')
+            .mockReturnValue(`http://${process.env.VAULT_HOST}:${process.env.VAULT_PORT}`);
+
+        when(core.getInput)
+            .calledWith('token')
+            .mockReturnValue('testtoken');
+
+        when(core.getInput)
+            .calledWith('namespace')
+            .mockReturnValue('ns1');
+    });
+
+    function mockInput(secrets) {
+        when(core.getInput)
+            .calledWith('secrets')
+            .mockReturnValue(secrets);
+    }
+
+    it('get simple secret', async () => {
+        mockInput('test secret')
+
+        await exportSecrets();
+
+        expect(core.exportVariable).toBeCalledWith('SECRET', 'SUPERSECRET_IN_NAMESPACE');
+    });
+
+    it('re-map secret', async () => {
+        mockInput('test secret | TEST_KEY')
+
+        await exportSecrets();
+
+        expect(core.exportVariable).toBeCalledWith('TEST_KEY', 'SUPERSECRET_IN_NAMESPACE');
+    });
+
+    it('get nested secret', async () => {
+        mockInput('nested/test otherSecret')
+
+        await exportSecrets();
+
+        expect(core.exportVariable).toBeCalledWith('OTHERSECRET', 'OTHERSUPERSECRET_IN_NAMESPACE');
+    });
+
+    it('get multiple secrets', async () => {
+        mockInput(`
+        test secret ;
+        test secret | NAMED_SECRET ;
+        nested/test otherSecret ;`);
+
+        await exportSecrets();
+
+        expect(core.exportVariable).toBeCalledTimes(3);
+
+        expect(core.exportVariable).toBeCalledWith('SECRET', 'SUPERSECRET_IN_NAMESPACE');
+        expect(core.exportVariable).toBeCalledWith('NAMED_SECRET', 'SUPERSECRET_IN_NAMESPACE');
+        expect(core.exportVariable).toBeCalledWith('OTHERSECRET', 'OTHERSUPERSECRET_IN_NAMESPACE');
+    });
+});

integration-ent/jest.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+    verbose: true
+};

jest.config.js

@@ -1,3 +1,3 @@
 module.exports = {
-    testPathIgnorePatterns: ['/node_modules/', '<rootDir>/integration/', '<rootDir>/e2e/'],
+    testPathIgnorePatterns: ['/node_modules/', '<rootDir>/integration/', '<rootDir>/e2e/','<rootDir>/integration-ent'],
 };

package.json

@@ -1,38 +1,51 @@
 {
-  "name": "vault-action",
+    "name": "vault-action",
-  "version": "0.1.0",
+    "version": "0.1.0",
-  "description": "A Github Action that allows you to consume vault secrets as secure environment variables.",
+    "description": "A Github Action that allows you to consume vault secrets as secure environment variables.",
-  "main": "index.js",
+    "main": "dist/index.js",
-  "scripts": {
+    "scripts": {
-    "test": "jest",
+        "build": "ncc build index.js -o dist",
-    "test:integration": "jest -c integration/jest.config.js",
+        "test": "jest",
-    "test:e2e": "jest -c e2e/jest.config.js"
+        "test:integration": "jest -c integration/jest.config.js",
-  },
+        "test:integration-ent": "jest -c integration-ent/jest.config.js",
-  "repository": {
+        "test:e2e": "jest -c e2e/jest.config.js"
-    "type": "git",
+    },
-    "url": "git+https://github.com/RichiCoder1/vault-action.git"
+    "release": {
-  },
+        "branch": "master",
-  "keywords": [
+        "plugins": [
-    "hashicorp",
+            "@semantic-release/commit-analyzer",
-    "vault",
+            "@semantic-release/release-notes-generator",
-    "github",
+            "@semantic-release/github"
-    "actions",
+        ],
-    "github-actions",
+        "ci": false
-    "javascript"
+    },
-  ],
+    "repository": {
-  "author": "Richard Simpson <richardsimpson@outlook.com>",
+        "type": "git",
-  "license": "MIT",
+        "url": "git+https://github.com/RichiCoder1/vault-action.git"
-  "bugs": {
+    },
-    "url": "https://github.com/RichiCoder1/vault-action/issues"
+    "keywords": [
-  },
+        "hashicorp",
-  "homepage": "https://github.com/RichiCoder1/vault-action#readme",
+        "vault",
-  "dependencies": {
+        "github",
-    "@actions/core": "^1.1.1",
+        "actions",
-    "got": "^9.6.0"
+        "github-actions",
-  },
+        "javascript"
-  "devDependencies": {
+    ],
-    "@types/jest": "^24.0.18",
+    "author": "Richard Simpson <richardsimpson@outlook.com>",
-    "jest": "^24.9.0",
+    "license": "MIT",
-    "jest-when": "^2.7.0"
+    "bugs": {
-  }
+        "url": "https://github.com/RichiCoder1/vault-action/issues"
+    },
+    "homepage": "https://github.com/RichiCoder1/vault-action#readme",
+    "dependencies": {
+        "@actions/core": "^1.1.1",
+        "got": "^9.6.0"
+    },
+    "devDependencies": {
+        "@types/jest": "^24.0.18",
+        "@zeit/ncc": "^0.20.5",
+        "jest": "^24.9.0",
+        "jest-when": "^2.7.0",
+        "semantic-release": "^15.13.24"
+    }
 }