@fishawack/lab-env 2.0.2 → 3.0.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 ## Changelog
 
+### 3.0.0 (2022-08-17)
+* [Feature] Added newly setup AWS accounts to the client prompts on `fw provision`
+* [Feature] Added key/dekey commands
+* [Change] Provisioned environment variables now append client to uniqueify the services created
+* [Change] `fw provision` no longer does two polls to cloudfront to speed up the process
+* [Change] Drupal now defaults to 8.1 php
+* [Bug] Added protocol to www in cloudfront function to ensure redirect works correctly
+* [Bug] Added posiexem to fix M1 chip issue on drupal
+
+### 2.2.0 (2022-08-10)
+* [Feature] Can now skip diagnose in `fw diagnose`
+* [Feature] Can now provision AWS environments using `fw provision`
+* [Change] Now requires node > 16
+* [Change] Auditted npm dependencies
+* [Misc] Added test coverage for new AWS service
+
+### 2.1.0 (2022-05-27)
+* [Change] Bumped core `0.0.21` to `0.1.0`
+
 ### 2.0.2 (2022-04-26)
 * [Change] Bumped core `0.0.20` to `0.0.21`
 * [Bug] Lock eb-cli due to breaking change

package/_Test/_helpers/globals.js

@@ -0,0 +1,10 @@
+const fs = require('fs');
+const os = require('os');
+const host = "ftp-fishawack.egnyte.com";
+const creds = JSON.parse(fs.readFileSync(`${os.homedir()}/targets/.ftppass`))[host];
+
+module.exports = {
+    opts: {encoding: 'utf8', stdio: process.argv.includes('--publish') ? 'pipe' : 'inherit'},
+    host,
+    creds
+};

package/_Test/key.js

@@ -0,0 +1,33 @@
+'use strict';
+
+const expect = require('chai').expect;
+const aws = require("../commands/create/services/aws/index.js");
+
+describe('key', async () => {
+    let account = 'fishawack';
+
+    before(async () => {
+        let res = await aws.iam.createFWIAMUser('fw-test-user', account);
+
+        // Wait for key as AWS doesn't provide a way to wait for it to becom eactive
+        await new Promise(resolve => setTimeout(() => resolve(), 10000));
+
+        process.env.AWS_ACCESS_KEY_ID = res.AccessKey.AccessKeyId;
+        process.env.AWS_SECRET_ACCESS_KEY = res.AccessKey.SecretAccessKey;
+    });
+    
+    it('Should be able to access AWS service', async () => {
+        let res;
+
+        try{ res = await aws.s3.listS3Buckets(); } catch(e){ console.log(e.message); }
+
+        expect(res).to.not.be.undefined;
+    });
+
+    after(async () => {
+        delete process.env.AWS_ACCESS_KEY_ID;
+        delete process.env.AWS_SECRET_ACCESS_KEY;
+
+        await aws.iam.removeIAMUser('fw-test-user', account);
+    });
+});

package/_Test/provision.js

@@ -0,0 +1,33 @@
+'use strict';
+
+const expect = require('chai').expect;
+const aws = require("../commands/create/services/aws/index.js");
+var fetch;
+
+describe('provision', async () => {
+    let config;
+    let repo = 'lab-env-test-suite';
+    let account = 'fishawack';
+
+    before(async () => {
+        fetch = (await import('node-fetch')).default;
+
+        config = await aws.static(repo, account);
+
+        await aws.s3.addFileToS3Bucket(repo, account, 'index.html', new TextEncoder().encode("test"));
+    });
+
+    it('Should provision s3 bucket', async () => {
+        expect((await fetch(config.url)).status).to.be.equal(200);
+    });
+
+    after(async () => {
+        await aws.s3.removeFileToS3Bucket(repo, account, 'index.html');
+
+        await aws.s3.removeS3Bucket(repo, account);
+        
+        await aws.cloudfront.removeCloudFrontDistribution(config.cloudfront, account);
+
+        await aws.cloudfront.removeCloudFrontFunction(repo, account);
+    });
+});

package/cli.js

@@ -4,10 +4,6 @@ process.env.CWD = process.cwd();
 
 const _ = require('./globals.js');
 
-const updateNotifier = require('update-notifier');
-const pkg = require('./package.json');
-updateNotifier({pkg, updateCheckInterval: 0}).notify();
-
 const execSync = require('child_process').execSync;
 
 const yargs = require('yargs/yargs');
@@ -16,9 +12,13 @@ const { hideBin } = require('yargs/helpers');
 const args = hideBin(process.argv);
 
 // Stop here if docker process not running and command isn't version or origin which don't require docker
-if(!_.services && !(args[0] === 'origin' || args[0] === '--version')) return;
+if(!_.services && !(args[0] === 'origin' || args[0] === '--version')) process.exit();
 
 (async () => {
+    const updateNotifier = (await import('update-notifier')).default;
+    const pkg = require('./package.json');
+    updateNotifier({pkg, updateCheckInterval: 0}).notify();
+
     process.env.REPO = _.repo;
     
     await _.ports.set();
@@ -59,7 +59,7 @@ if(!_.services && !(args[0] === 'origin' || args[0] === '--version')) return;
         ['build', 'config', 'down', 'mocha', 'rebuild', 'up', 'volumes', 'compose'].forEach(d => cli.command(...require(`./commands/docker/${d}.js`)));
 
         // Create commands
-        ['new', 'diagnose', 'delete'].forEach(d => cli.command(...require(`./commands/create/cmds/${d}.js`)));
+        ['new', 'provision', 'deprovision', 'diagnose', 'delete', 'key', 'dekey'].forEach(d => cli.command(...require(`./commands/create/cmds/${d}.js`)));
 
         cli.demandCommand(1, '')
             .wrap(null)

package/commands/create/cmds/dekey.js

@@ -0,0 +1,75 @@
+const _ = require('../../../globals.js');
+const utilities = require('../libs/utilities');
+const inquirer = require('inquirer');
+const aws = require('../services/aws/index.js');
+const fs = require('fs');
+const os = require('os');
+
+module.exports = [
+    'dekey',
+    false,
+    yargs => {},
+    async argv => {
+        let config = JSON.parse(fs.readFileSync(`${os.homedir()}/.lab-env`, {encoding: 'utf8'}));
+        let users = [];
+        let clients =  [];
+
+        let answer = await inquirer.prompt([
+            {
+                type: 'confirm',
+                name: 'check',
+                message: `Remove keys for all users`,
+                default: 'Y'
+            }
+        ]);
+
+        if(answer.check){
+            users = config.users.map(d => d.username);
+        } else {
+            answer = await inquirer.prompt([
+                {
+                    type: 'checkbox',
+                    name: 'users',
+                    message: 'Select users',
+                    choices: config.users.map(d => d.username)
+                }
+            ]);   
+
+            users = answer.users;
+        }
+
+        answer = await inquirer.prompt([
+            {
+                type: 'confirm',
+                name: 'check',
+                message: `Remove keys for all clients`,
+                default: 'Y'
+            }
+        ]);
+
+        if(answer.check){
+            clients = aws.clients;
+        } else {
+            answer = await inquirer.prompt([
+                {
+                    type: 'checkbox',
+                    name: 'clients',
+                    message: 'Select clients',
+                    choices: aws.clients
+                }
+            ]);   
+
+            clients = answer.clients;
+        }
+
+        for(let i = 0; i < clients.length; i++){
+            let client = clients[i];
+
+            for(let j = 0; j < users.length; j++){
+                let user = users[j];
+
+                await aws.iam.removeIAMUser(`fw-automation-${user}`, client);
+            }
+        }
+    }
+];

package/commands/create/cmds/deprovision.js

@@ -0,0 +1,54 @@
+const _ = require('../../../globals.js');
+const inquirer = require('inquirer');
+const aws = require('../services/aws/index.js');
+const utilities = require('../libs/utilities');
+
+module.exports = [
+    ['deprovision', 'deprov'],
+    false,
+    yargs => {
+        yargs.option('branch', {
+            alias: 'b',
+            describe: 'Branch to configure',
+            type: 'string'
+        });
+    },
+    async argv => {
+        let branch = argv.branch || _.branch;
+
+        const answers = await inquirer.prompt([
+            {
+                type: 'input',
+                name: 'id',
+                message: 'What is the Id of the CloudFront distribution?',
+                validate: (input) => !!input.length
+            },
+            {
+                type: 'list',
+                name: 'client',
+                message: 'Which AWS account is this deployed too?',
+                choices: aws.clients,
+                default: 'fishawack'
+            }
+        ]);
+
+        let answer = await inquirer.prompt([
+            {
+                type: 'confirm',
+                name: 'check',
+                message: `Deprovisioning ${utilities.colorize(aws.slug(_.repo, answers.client, branch), 'error')} from ${utilities.colorize(answers.client, 'error')} AWS account, are you sure you want to continue?`,
+                default: false
+            }
+        ]);
+
+        if(!answer.check){
+            process.exit(1);
+        }
+
+        try { await aws.s3.removeS3Bucket(aws.slug(_.repo, answers.client, branch), answers.client); } catch(e) {}
+        
+        try { await aws.cloudfront.removeCloudFrontDistribution(answers.id, answers.client); } catch(e) {}
+
+        try { await aws.cloudfront.removeCloudFrontFunction(aws.slug(_.repo, answers.client, branch), answers.client); } catch(e) {}
+    }
+];

package/commands/create/cmds/diagnose.js

@@ -57,9 +57,11 @@ module.exports = [
                 while(!await test.bitbucket() || !await bitbucket.check()){
                     await guide.bitbucket();
                 }
-    
-                while(!await test.gitlab() || !await gitlab.check()){
-                    await guide.gitlab();
+                
+                if(!await guide.gitlabSkip()) {
+                    while(!await test.gitlab() || !await gitlab.check()){
+                        await guide.gitlab();
+                    }
                 }
     
                 const userRepoName = vars.misc.bitbucket.username.split('@')[0].replace(/\./, '-');

package/commands/create/cmds/key.js

@@ -0,0 +1,99 @@
+const _ = require('../../../globals.js');
+const utilities = require('../libs/utilities');
+const inquirer = require('inquirer');
+const aws = require('../services/aws/index.js');
+const fs = require('fs');
+const os = require('os');
+
+module.exports = [
+    'key',
+    false,
+    yargs => {},
+    async argv => {
+        let config = JSON.parse(fs.readFileSync(`${os.homedir()}/.lab-env`, {encoding: 'utf8'}));
+        let users = [];
+        let clients =  [];
+
+        let answer = await inquirer.prompt([
+            {
+                type: 'confirm',
+                name: 'check',
+                message: `Set keys for all users`,
+                default: 'Y'
+            }
+        ]);
+
+        if(answer.check){
+            users = config.users.map(d => d.username);
+        } else {
+            answer = await inquirer.prompt([
+                {
+                    type: 'checkbox',
+                    name: 'users',
+                    message: 'Select users',
+                    choices: config.users.map(d => d.username)
+                }
+            ]);   
+
+            users = answer.users;
+        }
+
+        answer = await inquirer.prompt([
+            {
+                type: 'confirm',
+                name: 'check',
+                message: `Set keys for all clients`,
+                default: 'Y'
+            }
+        ]);
+
+        if(answer.check){
+            clients = aws.clients;
+        } else {
+            answer = await inquirer.prompt([
+                {
+                    type: 'checkbox',
+                    name: 'clients',
+                    message: 'Select clients',
+                    choices: aws.clients
+                }
+            ]);   
+
+            clients = answer.clients;
+        }
+
+        let credentials = {};
+
+        for(let i = 0; i < clients.length; i++){
+            let client = clients[i];
+
+            for(let j = 0; j < users.length; j++){
+                let user = users[j];
+
+                if(!credentials[user]){
+                    credentials[user] = {};
+                }
+
+                let res = await aws.iam.createFWIAMUser(`fw-automation-${user}`, client);
+
+                credentials[user][client] = {
+                    key: res.AccessKey && res.AccessKey.AccessKeyId || res.AccessKeyMetadata[0].AccessKeyId,
+                    secret: res.AccessKey && res.AccessKey.SecretAccessKey || '** secret **'
+                }
+            }
+        }
+
+        let output = '';
+
+        for(var user in credentials){
+            output += utilities.colorize(`\n${user}\n`, 'title');
+            for(var client in credentials[user]){
+                output += `\n[${client}]\n`;
+                output += `aws_access_key_id = ${credentials[user][client].key}\n`;
+                output += `aws_secret_access_key = ${credentials[user][client].secret}\n`;
+            }
+        }
+
+        console.log(output);
+    }
+];

package/commands/create/cmds/provision.js

@@ -0,0 +1,120 @@
+const _ = require('../../../globals.js');
+const utilities = require('../libs/utilities');
+const execSync = require('child_process').execSync;
+const inquirer = require('inquirer');
+const aws = require('../services/aws/index.js');
+const generator = require('generate-password');
+
+module.exports = [
+    ['provision', 'prov'],
+    'Provisions the deployment target',
+    yargs => {
+        yargs.option('branch', {
+            alias: 'b',
+            describe: 'Branch to configure',
+            type: 'string'
+        });
+    },
+    async argv => {
+        let branch = argv.branch || _.branch;
+        
+        let answer = await inquirer.prompt([
+            {
+                type: 'confirm',
+                name: 'check',
+                message: `Provisioning the ${utilities.colorize(branch, 'success')} branch, is this correct?`,
+                default: 'Y'
+            }
+        ]);
+
+        if(!answer.check){
+            process.exit(1);
+        }
+
+        const answers = await inquirer.prompt([
+            {
+                type: 'list',
+                name: 'stack',
+                message: 'What type of project are you deploying?',
+                choices: ['static'],
+                default: 'static'
+            },
+            {
+                type: 'list',
+                name: 'client',
+                message: 'Which AWS account should this be deployed too?',
+                choices: aws.clients,
+                default: 'fishawack'
+            },
+            {
+                type: 'confirm',
+                name: 'protected',
+                message: 'Should the site be password protected?',
+                default: true
+            }
+        ]);
+
+        let credentials = [];
+
+        if(answers.protected){
+            let user = {
+                another: true
+            };
+
+            while(user.another){
+                user = await inquirer.prompt([
+                    {
+                        type: 'input',
+                        name: 'username',
+                        message: 'Username',
+                        default: `${_.repo_safe}User${credentials.length ? `-${credentials.length}` : ''}`,
+                        validate: (input) => !!input.length
+                    },
+                    {
+                        type: 'input',
+                        name: 'password',
+                        message: 'Password (leave empty to generate)',
+                        default: generator.generate({ length: 10, numbers: true }),
+                        validate: (input) => !!input.length
+                    },
+                    {
+                        type: 'confirm',
+                        name: 'another',
+                        message: 'Add another user?',
+                        default: false
+                    }
+                ]);
+
+                credentials.push({username: user.username, password: user.password});
+            }
+        }
+
+        let config = {};
+        let infastructure;
+        
+        try{
+            infastructure = await aws.static(aws.slug(_.repo, answers.client, branch), answers.client, [{Key: 'repository', Value: _.repo}, {Key: 'environment', Value: branch}], credentials);
+        } catch(e){
+            console.log(e.message);
+            process.exit(1);
+        }
+        
+        config[branch] = {
+            deploy: {
+                "url": infastructure.url,
+                "location": infastructure.bucket.slice(1), // Remove / from start
+                "aws-s3": answers.client,
+                "aws-cloudfront": infastructure.cloudfront
+            }
+        };
+
+        if(credentials.length){
+            config[branch].deploy.users = credentials;
+        }
+
+        let stringify = JSON.stringify(config, null, 4);
+        let output = stringify.substring(1, stringify.length-1).trim();
+        execSync(`printf '${output}' | pbcopy`);
+        console.log(utilities.colorize(`\n${output}\n\n(copied to clipboard)`, 'title'));
+    }
+];

package/commands/create/libs/aws-cloudfront-auth.js

@@ -0,0 +1,77 @@
+function handler(event) {
+    // Redirect if www to non-www
+    if (event.request.headers.host.value.includes('www.')) {
+        var query = '';
+        var index = 0;
+
+        for(var key in event.request.querystring){
+            query += `${index ? '&' : '?'}${key}=${event.request.querystring[key].value}`;
+            index++;
+        }
+        
+        var response = {
+            statusCode: 301,
+            statusDescription: 'Moved Permanently',
+            headers: { "location": { "value": `https://${event.request.headers.host.value.split('www.')[1]}${event.request.uri}${query}` } }
+        };
+
+        return response;
+    }
+
+    // Redirect if no trailing slash
+    if(!event.request.uri.includes('.') && !event.request.uri.endsWith('/')){
+        var query = '';
+        var index = 0;
+
+        for(var key in event.request.querystring){
+            query += `${index ? '&' : '?'}${key}=${event.request.querystring[key].value}`;
+            index++;
+        }
+
+        return {
+            statusCode: 301,
+            statusDescription: 'Moved Permanently',
+            headers: { "location": { "value": `${event.request.uri}/${query}` } }
+        };
+    }
+    
+    var authHeaders = event.request.headers.authorization;
+
+    // The Base64-encoded Auth string that should be present.
+    // It is an encoding of `Basic base64([username]:[password])`
+    var expected = <%= credentials %>;
+
+    // If an Authorization header is supplied and it's an exact match, pass the
+    // request on through to CF/the origin without any modification.
+    if(authHeaders && expected.find(d => d === authHeaders.value)) {
+        // Rewrite url to append index.html if not present
+        var request = event.request;
+        var uri = request.uri;
+
+        // Check whether the URI is missing a file name.
+        if(uri.endsWith('/')) {
+            request.uri += 'index.html';
+        }
+        // Check whether the URI is missing a file extension.
+        else if(!uri.includes('.')) {
+            request.uri += '/index.html';
+        }
+
+        return request;
+    }
+
+    // But if we get here, we must either be missing the auth header or the
+    // credentials failed to match what we expected.
+    // Request the browser present the Basic Auth dialog.
+    var response = {
+        statusCode: 401,
+        statusDescription: 'Unauthorized',
+        headers: {
+            "www-authenticate": {
+                value: 'Basic'
+            }
+        },
+    };
+
+    return response;
+}

package/commands/create/libs/aws-cloudfront-simple.js

@@ -0,0 +1,51 @@
+function handler(event) {
+    // Redirect if www to non-www
+    if (event.request.headers.host.value.includes('www.')) {
+        var query = '';
+        var index = 0;
+
+        for(var key in event.request.querystring){
+            query += `${index ? '&' : '?'}${key}=${event.request.querystring[key].value}`;
+            index++;
+        }
+        
+        var response = {
+            statusCode: 301,
+            statusDescription: 'Moved Permanently',
+            headers: { "location": { "value": `https://${event.request.headers.host.value.split('www.')[1]}${event.request.uri}${query}` } }
+        };
+
+        return response;
+    }
+
+    // Redirect if no trailing slash
+    if(!event.request.uri.includes('.') && !event.request.uri.endsWith('/')){
+        var query = '';
+        var index = 0;
+
+        for(var key in event.request.querystring){
+            query += `${index ? '&' : '?'}${key}=${event.request.querystring[key].value}`;
+            index++;
+        }
+
+        return {
+            statusCode: 301,
+            statusDescription: 'Moved Permanently',
+            headers: { "location": { "value": `${event.request.uri}/${query}` } }
+        };
+    }
+    
+    var request = event.request;
+    var uri = request.uri;
+
+    // Check whether the URI is missing a file name.
+    if(uri.endsWith('/')) {
+        request.uri += 'index.html';
+    }
+    // Check whether the URI is missing a file extension.
+    else if(!uri.includes('.')) {
+        request.uri += '/index.html';
+    }
+
+    return request;
+}