@fishawack/lab-env 4.2.1 → 4.3.1

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 ## Changelog
 
+### 4.3.1 (2022-11-14)
+* [Bug] key and dekey can now be run outside of repos
+* [Bug] Use repo_safe for all compose commands
+
+### 4.3.0 (2022-11-09)
+* [Feature] Added newly setup AWS accounts to the client prompts on `fw provision`
+* [Feature] Laravels php and nginx images are now versioned
+* [Feature] Laravel php image now installs composer deps and copys the source code when building the production image
+* [Feature] Laravel nginx image now copys the source code when building the production image
+* [Feature] `fw diagnose` now additionally checks for the presence of `~/.gitconfig`
+* [Feature] `fw new` will now check for the existence of a prefix in the name before applying it automatically to prevent duplicate framework names in repos
+* [Feature] `fw key` now has instructions in the generated emails
+* [Feature] `fw key` now has its email separated out into a html file for easier coding
+* [Change] Laravels php and nginx images are no longer built but pulled from docker.hub
+* [Change] Laravels php and nginx images contain docker multi step builds to separate out the development from production
+* [Change] Laravel compose file now defines development as the multi step to build
+* [Change] Bumped diagnose version
+* [Bug] Fixed the version expansion on the automatic versioning of images
+* [Bug] Automatic versioning now usess conventional commits
+
 ### 4.2.1 (2022-10-21)
 * [Bug] `fw new` should pass through docker running check
 

package/commands/create/cmds/diagnose.js

@@ -16,6 +16,10 @@ module.exports = [
     async argv => {
         try{
             let preset = await guide.preset();
+            
+            while(!await test.gitconfig()){
+                await guide.gitconfig();
+            };
     
             while(!await test.ssh()){
                 await guide.ssh();
@@ -90,4 +94,4 @@ module.exports = [
             }
         }
     }
-];
+];

package/commands/create/cmds/key.js

@@ -3,6 +3,7 @@ const utilities = require('../libs/utilities');
 const inquirer = require('inquirer');
 const aws = require('../services/aws/index.js');
 const email = require('../services/email.js');
+const htmlEmail = require('fs').readFileSync(`${__dirname}/../templates/credentials.html`, {encoding: 'utf8'});
 
 module.exports = [
     'key',
@@ -107,7 +108,7 @@ module.exports = [
             output += outputUser;
 
             if(sendEmail){
-                await email.send(_.config.users.find(d => d.username === user).email, 'New AWS Keys', null, outputUser);
+                await email.send(_.config.users.find(d => d.username === user).email, 'New AWS Keys', `${htmlEmail}<pre><code>${outputUser.replace(/\n/g, '<br>')}</code></pre>`);
             }
         }
 

package/commands/create/cmds/new.js

@@ -27,8 +27,13 @@ module.exports = [
             console.log(utilities.colorize(`Template ${answers.template} not a valid template type`, 'error'));
             return;
         }
-
-        let name = `${template.prefix ? `${template.prefix}-` : ''}${answers.name}`;
+        
+        let name = answers.name;
+        
+        if(template.prefix && !name.startsWith(template.prefix + '-'))
+        {
+            name = `${template.prefix}-${name}`;
+        }
         
         if(/^[a-zA-Z0-9-_.]+$/.test(name)){
             // Create Remote Repositories
@@ -45,4 +50,4 @@ module.exports = [
             console.log(utilities.colorize(`Repo name can contain only letters, digits, '_', '-' and '.'`, 'helper'));
         }
     }
-];
+];

package/commands/create/services/aws/index.js

@@ -6,7 +6,7 @@ module.exports.iam = require("./iam.js");
 
 module.exports.slug = (repo, client, branch) => s3Safe(`${branch}-${repo}-${client}`);
 
-module.exports.clients = ['fishawack', 'abbvie', 'sanofigenzyme', 'gsk', 'janssen', 'astrazeneca', 'ptc', 'jazz', 'pfizer', 'heron', 'novartis', 'training', 'merck', 'acadia', 'travere', 'roche', 'utc', 'bayer', 'alcon', 'uhc'];
+module.exports.clients = ['fishawack', 'abbvie', 'sanofigenzyme', 'gsk', 'janssen', 'astrazeneca', 'ptc', 'jazz', 'pfizer', 'heron', 'novartis', 'training', 'merck', 'acadia', 'travere', 'roche', 'utc', 'bayer', 'alcon', 'uhc', 'chiesi', '3m', 'sarepta', 'ipsen'];
 
 module.exports.static = async (name, account, tags = [], credentials = []) => {
     let s3 = await module.exports.s3.createS3Bucket(name, account, tags);

package/commands/create/services/guide.js

@@ -322,4 +322,21 @@ module.exports.watertight = async () => {
     } else {
         throw('');
     }
-}
+}
+
+module.exports.gitconfig = async () => {
+    let inputs = await inquirer.prompt([
+        {
+            type: 'confirm',
+            name: 'confirm',
+            message: 'Generate git config file?',
+            default: true
+        }
+    ]);
+
+    if(inputs.confirm){
+        writeFileSync(`${homedir()}/.gitconfig`, '');
+    } else {
+        throw('');
+    }
+}

package/commands/create/services/test.js

@@ -156,4 +156,16 @@ module.exports.watertight = async () => {
     } finally{
         execSync('rm -rf ./.tmp/watertight-node-auto', {stdio: 'pipe'});
     }
-}
+}
+
+module.exports.gitconfig = async () => {
+    // Check ssh config exists
+    let spinner = new utils.Spinner('Looking for .gitconfig file');
+
+    if (fs.existsSync(`${os.homedir()}/.gitconfig`)) {
+        spinner.update('Found \'.gitconfig\' file');
+        return true;
+    } else {
+        spinner.update('Could not find \'.gitconfig\' file', 'fail');
+    }
+}

package/commands/create/templates/credentials.html

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Credentials</title>
+</head>
+<body>
+    <h3>Instructions</h3>
+
+    <p>These keys should be appended to a file called <strong>credentials</strong> found at:</p>
+        
+    <pre><code>~/.aws/credentials</code></pre></p>
+
+    <p>If this file doesn't exist you can create it with the command:</p>
+
+    <pre><code>mkdir -p ~/.aws && touch ~/.aws/credentials</code></pre>
+
+    <h3>Keys</h3>
+    <!-- Keys are inserted here in the import script -->
+</body>
+</html>

package/core/package.json

@@ -4,7 +4,7 @@
   "description": "lab-env docker config for the @fishawack/core npm module",
   "scripts": {
     "preversion": "docker login",
-    "postversion": "mv ./*/ ./$npm_package_version && docker build ./*/ -t fishawack/core:$npm_package_version --platform linux/amd64 -t fishawack/core:latest && docker push fishawack/core:$npm_package_version && docker push fishawack/core:latest && git add . && git commit -m 'Bumped core to $npm_package_version'"
+    "postversion": "mv ./*/ ./$npm_package_version && docker build ./*/ -t fishawack/core:$npm_package_version --platform linux/amd64 -t fishawack/core:latest && docker push fishawack/core:$npm_package_version && docker push fishawack/core:latest && git add . && git commit -m \"build: Bumped core to $npm_package_version\""
   },
   "author": "Mike Mellor",
   "license": "ISC"

package/globals.js

@@ -25,7 +25,7 @@ var exec;
 var running;
 var services;
 var branch;
-var diagnosis = '1.0.0';
+var diagnosis = '1.0.1';
 var opts = {encoding: 'utf8', stdio: 'inherit', shell: '/bin/bash'};
 
 try{
@@ -46,6 +46,8 @@ try{
     repo = path.basename(process.cwd());
 }
 
+const repo_safe = repo.replace(/\./g, '');
+
 try{ pkg = require(path.join(process.cwd(), 'package.json')); } catch(e){}
 
 try{ composer = require(path.join(process.cwd(), 'composer.json')); } catch(e){}
@@ -81,40 +83,50 @@ const version = pkg && pkg.devDependencies && (pkg.devDependencies['@fishawack/c
     process.env.VERSION = versions[0];
 // }
 
+// If dev dep installed, then assume running from npm linked local dev version of lab-env and point to build context rather than docker hub
+let linked = false;
+try { require('mocha'); linked = true; } catch(e) {}
+
 var core = `-f ${__dirname}/core/docker-compose.yml`;
 
-// If dev dep installed, then assume running from npm linked local dev version of lab-env and point to build context rather than docker hub
-try {
-    require('mocha');
+// If locally linked then use locally built compose files to test before publishing onto docker hub
+if(linked){
     core = `-f ${__dirname}/core/docker-compose-dev.yml ${core}`;
-} catch(e) {}
+}
 
 if(platform === 'laravel'){
     if(!existsSync(path.join(process.cwd(), '.env'))){
         copyFileSync(path.join(process.cwd(), '.env.example'), path.join(process.cwd(), '.env'));
     }
 
-    docker = `docker-compose --env-file ${path.join(process.cwd(), '.env')} -f ${__dirname}/laravel/8/docker-compose.yml ${core} -p ${repo}`;
+    let container = `-f ${__dirname}/laravel/8/docker-compose.yml`;
+
+    // If linked locally then use locally built php image
+    if(linked){
+        container = `-f ${__dirname}/laravel/8/docker-compose-dev.yml ${container}`;
+    }
+
+    docker = `docker-compose --env-file ${path.join(process.cwd(), '.env')} ${container} ${core} -p ${repo_safe}`;
 } else if(platform === 'wordpress'){
     if(!existsSync(path.join(process.cwd(), '.env'))){
         copyFileSync(path.join(process.cwd(), '.env.example'), path.join(process.cwd(), '.env'));
     }
 
-    docker = `docker-compose --env-file ${path.join(process.cwd(), '.env')} -f ${__dirname}/wordpress/5.7.2/docker-compose.yml ${core} -p ${repo}`;
+    docker = `docker-compose --env-file ${path.join(process.cwd(), '.env')} -f ${__dirname}/wordpress/5.7.2/docker-compose.yml ${core} -p ${repo_safe}`;
 } else if(platform === "drupal"){
     if(!existsSync(path.join(process.cwd(), '.env'))){
         copyFileSync(path.join(process.cwd(), '.env.example'), path.join(process.cwd(), '.env'));
     }
     
-    docker = `docker-compose --env-file ${path.join(process.cwd(), '.env')} -f ${__dirname}/drupal/9/docker-compose.yml ${core} -p ${repo}`;
+    docker = `docker-compose --env-file ${path.join(process.cwd(), '.env')} -f ${__dirname}/drupal/9/docker-compose.yml ${core} -p ${repo_safe}`;
 } else if(platform === "craftcms"){
     if(!existsSync(path.join(process.cwd(), '.env'))){
         copyFileSync(path.join(process.cwd(), '.env.example'), path.join(process.cwd(), '.env'));
     }
 
-    docker = `docker-compose --env-file ${path.join(process.cwd(), '.env')} -f ${__dirname}/craftcms/3/docker-compose.yml ${core} -p ${repo}`;
+    docker = `docker-compose --env-file ${path.join(process.cwd(), '.env')} -f ${__dirname}/craftcms/3/docker-compose.yml ${core} -p ${repo_safe}`;
 } else  {
-    docker = `docker-compose ${core} -p ${repo}`;
+    docker = `docker-compose ${core} -p ${repo_safe}`;
 }
 
 try{
@@ -125,8 +137,8 @@ try{
     run = `${method} core bash -l`;
 } catch(e){}
 
-// Always allow diagnose, diag, version, help and origin through
-if(args[0] !== 'diag' && args[0] !== 'diagnose' && args[0] !== 'origin' && args[0] !== '--version' && args[0] !== '--help' && args[0] !== 'new'){
+// Always allow commands that don't require a repository through
+if(args[0] !== 'diag' && args[0] !== 'diagnose' && args[0] !== 'origin' && args[0] !== '--version' && args[0] !== '--help' && args[0] !== 'new' && args[0] !== 'key' && args[0] !== 'dekey'){
     // Stop here if diagnosis either unset or outdated
     if(!config.diagnosis || semver.diff(config.diagnosis, diagnosis) === 'major'){
         console.log(`${utilities.colorize(`@fishawack/lab-env`, 'title')} diagnosis is ${utilities.colorize(`outdated`, 'error')}.\n\nRun ${utilities.colorize(`fw diagnose`, 'success')} to reconfigure.`);
@@ -148,7 +160,7 @@ module.exports = {
     platform,
     repo,
     branch,
-    repo_safe: repo.replace(/\./g, ''),
+    repo_safe,
     pkg,
     docker,
     method,

package/laravel/8/docker-compose-dev.yml

@@ -0,0 +1,11 @@
+services:
+  nginx:
+    build: 
+      context: ./nginx/
+      dockerfile: Dockerfile
+      target: development
+  php:
+    build: 
+      context: ./php/
+      dockerfile: Dockerfile
+      target: development

package/laravel/8/docker-compose.yml

@@ -15,28 +15,22 @@ services:
       - mysql:/var/lib/mysql
   nginx:
     platform: linux/amd64
-    image: nginx:1.19
+    image: fishawack/lab-env-laravel-8-nginx:latest
     networks:
       - default
     volumes:
       - $CWD/:/app
-      - ./nginx/nginx.conf:/etc/nginx/conf.d/default.conf
     ports:
       - "${PORT_WEB:-8000}:80"
   php:
     platform: linux/amd64
-    build: 
-      context: ./php/
-      dockerfile: Dockerfile
-    image: lab-env/laravel/8/php:0.0.2
+    image: fishawack/lab-env-laravel-8-php:latest
     init: true
     working_dir: /app
     networks:
       - default
     volumes:
       - $CWD/:/app
-      - ./php/custom.conf:/opt/bitnami/php/etc/custom.conf
-      - ./php/policy.xml:/etc/ImageMagick-6/policy.xml
       - vendor:/app/vendor
   redis:
     platform: linux/amd64

package/laravel/8/nginx/Dockerfile

@@ -0,0 +1,11 @@
+FROM nginx:1.19 AS development
+
+MAINTAINER Mike Mellor
+
+# Copy nginx conf
+COPY ./nginx.conf /etc/nginx/conf.d/default.conf
+
+FROM fishawack/lab-env-laravel-8-nginx:latest AS production
+
+# Copy source code into container
+COPY . /app

package/laravel/8/nginx/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "nginx",
+  "version": "0.1.0",
+  "description": "lab-env docker config for the nginx module",
+  "scripts": {
+    "preversion": "docker login",
+    "postversion": "docker build -t fishawack/lab-env-laravel-8-nginx:$npm_package_version --target development --platform linux/amd64 -t fishawack/lab-env-laravel-8-nginx:latest . && docker push fishawack/lab-env-laravel-8-nginx:$npm_package_version && docker push fishawack/lab-env-laravel-8-nginx:latest && git add . && git commit -m \"build: Bumped fishawack/lab-env-laravel-8-nginx to $npm_package_version\""
+  },
+  "author": "Mike Mellor",
+  "license": "ISC"
+}

package/laravel/8/php/Dockerfile

@@ -1,4 +1,4 @@
-FROM chialab/php:7.4-fpm
+FROM chialab/php:7.4-fpm AS development
 
 MAINTAINER Mike Mellor
 
@@ -6,6 +6,23 @@ MAINTAINER Mike Mellor
 RUN apt-get update && \
     apt-get install -y ghostscript
 
+# Copy php conf
+COPY ./custom.conf /opt/bitnami/php/etc/custom.conf
+
+# Copy ImageMagick policy
+COPY ./policy.xml /etc/ImageMagick-6/policy.xml
+
 # Cleanup apt-get install folders
 RUN apt-get clean && \
-    rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+    rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+
+FROM fishawack/lab-env-laravel-8-php:latest AS production
+
+# Copy source code into container
+COPY . /app
+
+# Install composer dependencies
+RUN TEMPFILE=$(mktemp) && \
+    curl -o "$TEMPFILE" "https://getcomposer.org/installer" && \
+    php <"$TEMPFILE" && \
+    ./composer.phar install -d /app --no-dev --no-interaction --no-ansi --optimize-autoloader

package/laravel/8/php/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "php",
+  "version": "0.3.0",
+  "description": "lab-env docker config for the php module",
+  "scripts": {
+    "preversion": "docker login",
+    "postversion": "docker build -t fishawack/lab-env-laravel-8-php:$npm_package_version --target development --platform linux/amd64 -t fishawack/lab-env-laravel-8-php:latest . && docker push fishawack/lab-env-laravel-8-php:$npm_package_version && docker push fishawack/lab-env-laravel-8-php:latest && git add . && git commit -m \"build: Bumped fishawack/lab-env-laravel-8-php to $npm_package_version\""
+  },
+  "author": "Mike Mellor",
+  "license": "ISC"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fishawack/lab-env",
-  "version": "4.2.1",
+  "version": "4.3.1",
   "description": "Docker manager for FW",
   "main": "cli.js",
   "scripts": {