@fishawack/lab-env 4.25.3 → 4.27.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## Changelog
 
+### 4.27.0 (2024-04-08)
+* [Feature] can now provision fullstack environments
+* [Feature] added new clients
+* [Feature] can override the mail driver
+
+### 4.26.0 (2024-03-20)
+* [Feature] can override laravel 8 nginx dockerfile in project root
+
 ### 4.25.3 (2024-02-09)
 * [Change] Bumped fishawack/lab-env-core-1 to 1.3.3
 

package/_Test/provision.js

@@ -1,33 +1,56 @@
 'use strict';
 
 const expect = require('chai').expect;
+const execSync = require('child_process').execSync;
 const aws = require("../commands/create/services/aws/index.js");
 var fetch;
 
-describe('provision', async () => {
+describe('provision', () => {
     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"));
+    describe('static', () => {
+        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.staticTerminate(repo, account, repo, "development", config.cloudfront);
+        });
     });
 
-    it('Should provision s3 bucket', async () => {
-        expect((await fetch(config.url)).status).to.be.equal(200);
-    });
+    describe('fullstack', () => {
+        before(async () => {
+            fetch = (await import('node-fetch')).default;
+
+            process.env.REPO = repo;
 
-    after(async () => {
-        await aws.s3.removeFileToS3Bucket(repo, account, 'index.html');
+            config = await aws.fullstack(repo, account, [], [], repo, "development", "wordpress");
+        });
+    
+        it('Should provision elastic beanstalk environment', async () => {
+            expect((await fetch(config.url.replace('https://', 'http://'))).status).to.be.equal(200);
+        });
+    
+        after(async () => {    
+            await aws.fullstackTerminate(repo, account, repo, "development");
 
-        await aws.s3.removeS3Bucket(repo, account);
-        
-        await aws.cloudfront.removeCloudFrontDistribution(config.cloudfront, account);
+            execSync(`rm -rf .elasticbeanstalk`, {encoding: 'utf8', stdio: 'inherit'});
+            execSync(`rm -rf .ebextensions`, {encoding: 'utf8', stdio: 'inherit'});
+            execSync(`rm -rf .platform`, {encoding: 'utf8', stdio: 'inherit'});
 
-        await aws.cloudfront.removeCloudFrontFunction(repo, account);
+            delete process.env.REPO;
+        });
     });
 });

package/_Test/s3.js

@@ -0,0 +1,35 @@
+'use strict';
+
+const expect = require('chai').expect;
+const s3 = require("../commands/create/services/aws/s3.js");
+
+describe('s3', () => {
+    let repo = 'lab-env-test-suite';
+    let account = 'fishawack';
+
+    describe('terminate', () => {
+        before(async () => {
+            await s3.createS3Bucket(repo, account);
+    
+            await s3.addFileToS3Bucket(repo, account, 'index.html', new TextEncoder().encode("test"));
+        });
+    
+        it('Should remove all files from bucket during terminate process', async () => {
+            let err;
+
+            await s3.emptyS3Bucket(repo, account);
+
+            try { await s3.removeS3Bucket(repo, account); } catch (e) { err = e; }
+            
+            expect(err).to.be.undefined;
+        });
+    
+        after(async () => {
+            try {
+                await s3.removeFileToS3Bucket(repo, account, 'index.html');
+
+                await s3.removeS3Bucket(repo, account);
+            } catch (e) {}
+        });
+    });
+});

package/_Test/utilities.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const expect = require('chai').expect;
-const { s3Safe } = require("../commands/create/libs/utilities.js");
+const { s3Safe, ebSafe } = require("../commands/create/libs/utilities.js");
 
 describe('utilities', async () => {
     describe('s3Safe', () => {
@@ -36,5 +36,39 @@ describe('utilities', async () => {
         it('Should remove any special chars', async () => {
             expect(s3Safe('!@#$%^&*()=_+;,./<>?~`|').match(/[\!\@\#\$\%\^\&\*\(\)\=\_\+\;\,\.\/\<\>\?\~\`\|]/g)).to.be.null;
         });
+    });
+
+    describe('ebSafe', () => {
+        it('Should enforce service name to be at least 4 chars', async () => {
+            expect(ebSafe('a').length).to.be.greaterThanOrEqual(4);
+        });
+
+        it('Should limit service name to 40 chars', async () => {
+            expect(ebSafe('a'.repeat(100)).length).to.be.lessThanOrEqual(40);
+        });
+    
+        it('Should remove any uppercase chars', async () => {
+            expect(/^[A-Z]*$/.test(ebSafe('TEST'))).to.be.false;
+        });
+
+        it('Should convert . to -', async () => {
+            expect(ebSafe('...').match(/\./g)).to.be.null;
+        });
+
+        it('Should convert _ to -', async () => {
+            expect(ebSafe('___').match(/\_/g)).to.be.null;
+        });
+
+        it('Should start with a number or char', async () => {
+            expect(/[a-z0-9]/i.test(ebSafe('___').charAt(0))).to.be.true;
+        });
+
+        it('Should end with a number or char', async () => {
+            expect(/[a-z0-9]/i.test(ebSafe('___').charAt(ebSafe('___').length - 1))).to.be.true;
+        });
+
+        it('Should remove any special chars', async () => {
+            expect(ebSafe('!@#$%^&*()=_+;,./<>?~`|').match(/[\!\@\#\$\%\^\&\*\(\)\=\_\+\;\,\.\/\<\>\?\~\`\|]/g)).to.be.null;
+        });
     })
 });

package/cli.js

@@ -15,8 +15,6 @@ const args = hideBin(process.argv);
     const updateNotifier = (await import('update-notifier')).default;
     const pkg = require('./package.json');
     updateNotifier({pkg, updateCheckInterval: 0}).notify({isGlobal: true});
-
-    process.env.REPO = _.repo;
     
     await _.ports.set();
 

package/commands/create/cmds/deprovision.js

@@ -2,6 +2,7 @@ const _ = require('../../../globals.js');
 const inquirer = require('inquirer');
 const aws = require('../services/aws/index.js');
 const utilities = require('../libs/utilities');
+const { stack, client } = require('../libs/prompts.js');
 
 module.exports = [
     ['deprovision', 'deprov'],
@@ -16,27 +17,42 @@ module.exports = [
     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
-            },
+        let answer = await inquirer.prompt([
             {
-                type: 'list',
-                name: 'client',
-                message: 'Which AWS account is this deployed too?',
-                choices: aws.clients,
-                default: 'fishawack'
+                type: 'confirm',
+                name: 'check',
+                message: `Deprovisioning the ${utilities.colorize(branch, 'success')} branch, is this correct?`,
+                default: 'Y'
             }
         ]);
 
-        let answer = await inquirer.prompt([
+        if(!answer.check){
+            process.exit(1);
+        }
+
+        let answers = await inquirer.prompt([
+            stack,
+            client
+        ]);
+
+        if(answers.stack === "static"){
+            answers = {...answers, ...(await inquirer.prompt([
+                {
+                    type: 'input',
+                    name: 'id',
+                    message: 'What is the Id of the CloudFront distribution?',
+                    validate: (input) => !!input.length
+                }
+            ]))};
+        }
+
+        const slug = aws.slug(_.repo_safe, answers.client, branch, answers.stack === "static" ? "s3" : "eb");
+
+        answer = await inquirer.prompt([
             {
                 type: 'confirm',
                 name: 'check',
-                message: `Deprovisioning ${utilities.colorize(aws.slug(_.repo_safe, answers.client, branch), 'error')} from ${utilities.colorize(answers.client, 'error')} AWS account, are you sure you want to continue?`,
+                message: `Deprovisioning ${utilities.colorize(slug, 'error')} from ${utilities.colorize(answers.client, 'error')} AWS account, are you sure you want to continue?`,
                 default: false
             }
         ]);
@@ -45,10 +61,6 @@ module.exports = [
             process.exit(1);
         }
 
-        try { await aws.s3.removeS3Bucket(aws.slug(_.repo_safe, 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_safe, answers.client, branch), answers.client); } catch(e) {}
+        await aws[`${answers.stack}Terminate`](slug, answers.client, _.repo_safe, branch, answers.id);
     }
 ];

package/commands/create/cmds/provision.js

@@ -4,6 +4,8 @@ const execSync = require('child_process').execSync;
 const inquirer = require('inquirer');
 const aws = require('../services/aws/index.js');
 const generator = require('generate-password');
+const { stack, client } = require('../libs/prompts.js');
+const { frameworks } = require('../libs/vars');
 
 module.exports = [
     ['provision', 'prov'],
@@ -31,29 +33,42 @@ module.exports = [
             process.exit(1);
         }
 
-        const answers = await inquirer.prompt([
-            {
-                type: 'list',
-                name: 'stack',
-                message: 'What type of project are you deploying?',
-                choices: ['static'],
-                default: 0
-            },
-            {
-                type: 'list',
-                name: 'client',
-                message: 'Which AWS account should this be deployed too?',
-                choices: aws.clients.sort(),
-                default: 0,
-                loop: false
-            },
+        let answers = await inquirer.prompt([
+            stack
+        ]);
+
+        if(answers.stack === "fullstack"){
+            answers = {...answers, ...(await inquirer.prompt([
+                {
+                    type: 'list',
+                    name: 'framework',
+                    message: 'What type of framework are you deploying?',
+                    choices: frameworks.concat({
+                        name: "none",
+                        value: "default"
+                    })
+                },
+                {
+                    type: 'list',
+                    name: 'availability',
+                    message: 'What availability is required?',
+                    choices: [
+                        'low',
+                        'high'
+                    ]
+                }
+            ]))};
+        }
+
+        answers = {...answers, ...(await inquirer.prompt([
+            client,
             {
                 type: 'confirm',
                 name: 'protected',
                 message: 'Should the site be password protected?',
                 default: true
             }
-        ]);
+        ]))};
 
         let credentials = [];
 
@@ -92,22 +107,28 @@ module.exports = [
 
         let config = {};
         let infastructure;
+        const slug = aws.slug(_.repo_safe, answers.client, branch, answers.stack === "static" ? "s3" : "eb");
         
         try{
-            infastructure = await aws.static(aws.slug(_.repo_safe, answers.client, branch), answers.client, [{Key: 'repository', Value: _.repo}, {Key: 'environment', Value: branch}], credentials);
+            infastructure = await aws[answers.stack](slug, answers.client, [{Key: 'repository', Value: _.repo}, {Key: 'environment', Value: branch}, {Key: 'automated', Value: true}], credentials, _.repo_safe, branch, answers.framework, answers.availability);
         } 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
-            }
+
+        const deploy = answers.stack === "static" ? {
+            "url": infastructure.url,
+            "location": infastructure.bucket.slice(1), // Remove / from start
+            "aws-s3": answers.client,
+            "aws-cloudfront": infastructure.cloudfront
+        } : {
+            "url": infastructure.url,
+            "location": "/var/www/html",
+            "aws-eb": infastructure.environment,
+            "paths": infastructure.paths,
         };
+        
+        config[branch] = { deploy };
 
         if(credentials.length){
             config[branch].deploy.users = credentials;

package/commands/create/libs/prompts.js

@@ -1,6 +1,7 @@
 const inquirer = require('inquirer');
 
 const { templates } = require('./vars');
+const { clients } = require("../services/aws/index.js")
 
 const addPrompt = module.exports.addPrompt = (type, prompts, flags) => {
     switch(type) {
@@ -57,4 +58,21 @@ module.exports.generatePrompts = async flags => {
         ...flags,
         ...answers
     };
+};
+
+module.exports.stack = {
+    type: 'list',
+    name: 'stack',
+    message: 'What type of project are you deploying?',
+    choices: ['static', 'fullstack'],
+    default: 0
+};
+
+module.exports.client = {
+    type: 'list',
+    name: 'client',
+    message: 'Which AWS account should this be deployed too?',
+    choices: clients.sort(),
+    default: 0,
+    loop: false
 };

package/commands/create/libs/utilities.js

@@ -100,12 +100,25 @@ module.exports.encode = (username, password) => {
 }
 
 module.exports.s3Safe = (name) => {
+    return module.exports.nameSafe(name);
+}
+
+module.exports.ebSafe = (name) => {
+    return module.exports.nameSafe(name, "eb");
+}
+
+module.exports.nameSafe = (name, service = "s3") => {
     let safe = name;
     let hash = crypto.createHash('md5').update(name).digest('hex');
     let suffix = `-${hash.substring(0, 8)}`;
     let prefix = 'fw-auto-';
+    let maxLength = 63; //s3
+
+    if(service === "eb"){
+        maxLength = 40;
+    }
     
-    safe = safe.substring(0, (63 - suffix.length - prefix.length));
+    safe = safe.substring(0, (maxLength - suffix.length - prefix.length));
     safe = safe.replace(/[^a-zA-Z0-9-_. ]/g, ""); // Remove special chars except . _ - as these are all transformed into -
     safe = safe.toLowerCase();
     safe = `${prefix}${safe}`;
@@ -114,4 +127,22 @@ module.exports.s3Safe = (name) => {
     safe = safe.replace(/\_/g, '-');
 
     return safe;
+}
+
+module.exports.poll = async (cb, resolve, reject) => {
+    let res;
+
+    do{
+        await new Promise((resolve) => setTimeout(() => resolve(), 5000));
+
+        await module.exports.Spinner.prototype.ping();
+
+        res = await cb();
+
+        if(reject && reject(res)){
+            throw new Error(`Polling received reject response`);
+        }
+    } while(resolve(res))
+
+    return res;
 }