Merge branch 'rc-4.0.0' into upgrade-karma-jasmine

.travis.yml

@@ -1,3 +1,7 @@
+os:
+  - linux
+  - osx
+
 language: node_js
 dist: bionic
 
@@ -18,8 +22,8 @@ branches:
     - /^[0-9]+\.[0-9]+\.[0-9]+.*/
 
 before_install:
- - sudo cp ./ssl/skyux-ca.crt /usr/local/share/ca-certificates/skyux-ca.crt
- - sudo update-ca-certificates
+  - npm i -g @skyux-sdk/cli
+  - skyux certs install
 
 script: "npm run lint && npm run $TEST_COMMAND"
 

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 3.11.0 (2019-10-28)
+
+- Updated the local server to use the self-signed certificate implementation introduced in `@skyux-sdk/[email protected]`. See the [SSL documentation](https://developer.blackbaud.com/skyux/learn/get-started/prereqs/ssl-certificate). [#168](https://github.com/blackbaud/skyux-sdk-builder/pull/168)
+
 # 3.10.0 (2019-09-30)
 
 - Upgraded `help-client` to `2.1.0`. [#161](https://github.com/blackbaud/skyux-sdk-builder/pull/161) Thanks, [@Blackbaud-ColbyWhite](https://github.com/Blackbaud-ColbyWhite)!

appveyor.yml

@@ -9,6 +9,8 @@ environment:
 install:
   - choco install googlechrome --ignore-checksums
   - ps: Install-Product node $env:nodejs_version
+  - npm i -g @skyux-sdk/cli
+  - skyux certs install
   - npm install
 
 test_script:

cli/e2e.js

@@ -183,7 +183,7 @@ function e2e(command, argv, skyPagesConfig, webpack) {
     return killServers(0);
   }
 
-  server.start()
+  server.start(argv)
     .then((port) => {
       argv.assets = 'https://localhost:' + port;
 

cli/utils/cert-resolver.js

@@ -0,0 +1,33 @@
+/*jslint node: true */
+'use strict';
+
+const fs = require('fs-extra');
+const logger = require('@blackbaud/skyux-logger');
+
+function error(prop, code) {
+  logger.error(`Unable to resolve certificate property ${prop} (code ${code}).`);
+  logger.error('Please install the latest SKY UX CLI and run `skyux certs install`.');
+}
+
+function read(argv, prop) {
+  if (!argv[prop]) {
+    error(prop, 0);
+  } else if (!fs.pathExistsSync(argv[prop])) {
+    error(prop, 1);
+  } else {
+    return fs.readFileSync(argv[prop]);
+  }
+}
+
+function readCert(argv) {
+  return read(argv, 'sslCert');
+}
+
+function readKey(argv) {
+  return read(argv, 'sslKey');
+}
+
+module.exports = {
+  readCert,
+  readKey
+};

cli/utils/karma-utils.js

@@ -83,7 +83,7 @@ function run(command, argv, specsPattern) {
       });
     }
 
-    server.start();
+    server.start(argv);
   });
 }
 

cli/utils/run-build.js

@@ -149,7 +149,7 @@ function cleanupDist() {
 function buildServe(argv, skyPagesConfig, webpack, isAot) {
   const base = skyPagesConfigUtil.getAppBase(skyPagesConfig);
   return server
-    .start(base)
+    .start(argv, base)
     .then(port => {
       argv.assets = argv.assets || `https://localhost:${port}`;
       return buildCompiler(argv, skyPagesConfig, webpack, isAot)

cli/utils/server.js

@@ -1,13 +1,13 @@
 /*jslint node: true */
 'use strict';
 
-const fs = require('fs');
 const path = require('path');
 const portfinder = require('portfinder');
 const express = require('express');
 const https = require('https');
 const cors = require('cors');
 const logger = require('@blackbaud/skyux-logger');
+const certResolver = require('./cert-resolver');
 
 const app = express();
 
@@ -17,7 +17,7 @@ let server;
  * Starts the httpServer
  * @name start
  */
-function start(root, distPath) {
+function start(argv, root, distPath) {
   return new Promise((resolve, reject) => {
 
     const dist = path.resolve(process.cwd(), distPath || 'dist');
@@ -33,8 +33,8 @@ function start(root, distPath) {
     }
 
     const options = {
-      cert: fs.readFileSync(path.resolve(__dirname, '../../ssl/server.crt')),
-      key: fs.readFileSync(path.resolve(__dirname, '../../ssl/server.key'))
+      cert: certResolver.readCert(argv),
+      key: certResolver.readKey(argv)
     };
 
     server = https.createServer(options, app);

config/webpack/serve.webpack.config.js

@@ -1,7 +1,6 @@
 /*jslint node: true */
 'use strict';
 
-const fs = require('fs');
 const path = require('path');
 const webpackMerge = require('webpack-merge');
 const NamedModulesPlugin = require('webpack/lib/NamedModulesPlugin');
@@ -10,6 +9,7 @@ const HotModuleReplacementPlugin = require('webpack/lib/HotModuleReplacementPlug
 
 const skyPagesConfigUtil = require('../sky-pages/sky-pages.config');
 const browser = require('../../cli/utils/browser');
+const certResolver = require('../../cli/utils/cert-resolver');
 
 const tsLoaderUtil = require('./ts-loader-rule');
 
@@ -73,8 +73,8 @@ function getWebpackConfig(argv, skyPagesConfig) {
         index: skyPagesConfigUtil.getAppBase(skyPagesConfig)
       },
       https: {
-        key: fs.readFileSync(path.join(__dirname, '../../ssl/server.key')),
-        cert: fs.readFileSync(path.join(__dirname, '../../ssl/server.crt'))
+        cert: certResolver.readCert(argv),
+        key: certResolver.readKey(argv)
       },
       publicPath: skyPagesConfigUtil.getAppBase(skyPagesConfig)
     },

e2e/shared/common.js

@@ -1,7 +1,8 @@
 /*jshint node: true*/
-/*global browser, element, by*/
+/*global browser*/
 'use strict';
 
+const os = require('os');
 const fs = require('fs-extra');
 const path = require('path');
 const rimraf = require('rimraf');
@@ -18,11 +19,15 @@ const skyuxConfigPath = path.resolve(process.cwd(), tmp, 'skyuxconfig.json');
 const appExtrasPath = path.resolve(process.cwd(), tmp, 'src/app/app-extras.module.ts');
 const cliPath = `../e2e/shared/cli`;
 
+// This is normally provided by the CLI.
+const sslCert = path.resolve(`${os.homedir()}/.skyux/certs/skyux-server.crt`);
+const sslKey = path.resolve(`${os.homedir()}/.skyux/certs/skyux-server.key`);
+
 let skyuxConfigOriginal;
 let appExtrasOriginal;
 let webpackServer;
-let _exitCode;
-let _port;
+let spyExitCode;
+let spyPort;
 
 /**
  * Stops the server.
@@ -40,7 +45,7 @@ function afterAll() {
   if (appExtrasOriginal) {
     resetAppExtras();
   }
-};
+}
 
 /**
  * Adds event listeners to serve and resolves a promise.
@@ -53,7 +58,7 @@ function bindServe() {
     webpackServer.stdout.on('data', data => {
       const dataAsString = log(data);
       if (dataAsString.indexOf('Compiled successfully.') > -1) {
-        resolve(_port);
+        resolve(spyPort);
       }
       if (dataAsString.indexOf('Failed to compile.') > -1) {
         reject(dataAsString);
@@ -91,7 +96,7 @@ function exec(cmd, args, opts) {
  * Returns the last exit code.
  */
 function getExitCode() {
-  return _exitCode;
+  return spyExitCode;
 }
 
 /**
@@ -113,12 +118,12 @@ function prepareBuild(config) {
   function serve(exitCode) {
 
     // Save our exitCode for testing
-    _exitCode = exitCode;
+    spyExitCode = exitCode;
 
     // Reset skyuxconfig.json
     resetConfig();
 
-    return server.start('unused-root', tmp)
+    return server.start({ sslCert, sslKey }, 'unused-root', tmp)
       .then(port => browser.get(`https://localhost:${port}/dist/`));
   }
 
@@ -140,15 +145,15 @@ function prepareServe() {
 
   if (webpackServer) {
     return bindServe();
-  } else {
-    return new Promise((resolve, reject) => {
-      portfinder.getPortPromise()
-        .then(writeConfigServe)
-        .then(bindServe)
-        .then(resolve)
-        .catch(err => reject(err));
-    });
   }
+
+  return new Promise((resolve, reject) => {
+    portfinder.getPortPromise()
+      .then(writeConfigServe)
+      .then(bindServe)
+      .then(resolve)
+      .catch(err => reject(err));
+  });
 }
 
 /**
@@ -189,15 +194,27 @@ function writeConfig(json) {
  */
 function writeConfigServe(port) {
   return new Promise(resolve => {
-    _port = port;
+    spyPort = port;
     const skyuxConfigWithPort = merge(true, skyuxConfigOriginal, {
       app: {
         port: port
       }
     });
 
     writeConfig(skyuxConfigWithPort);
-    const args = [cliPath, `serve`, `-l`, `none`, `--logFormat`, `none`];
+
+    const args = [
+      cliPath,
+      `serve`,
+      `-l`,
+      `none`,
+      `--logFormat`,
+      `none`,
+      `--sslCert`,
+      sslCert,
+      `--sslKey`,
+      sslKey
+    ];
     webpackServer = childProcessSpawn(`node`, args, cwdOpts);
     resetConfig();
     resolve();
@@ -227,7 +244,7 @@ function writeAppFile(filePath, content) {
  */
 function verifyAppFolder(folderPath) {
   const resolvedFolderPath = path.join(path.resolve(tmp), 'src', 'app', folderPath);
-  return new Promise((resolve, reject) => {
+  return new Promise((resolve) => {
     if (!fs.existsSync(resolvedFolderPath)) {
       fs.mkdirSync(resolvedFolderPath);
     }
@@ -273,5 +290,7 @@ module.exports = {
   writeAppFile: writeAppFile,
   removeAppFolderItem: removeAppFolderItem,
   verifyAppFolder: verifyAppFolder,
-  writeAppExtras: writeAppExtras
+  writeAppExtras: writeAppExtras,
+  sslCert,
+  sslKey
 };

e2e/skyux-e2e.e2e-spec.js

@@ -4,7 +4,18 @@
 const common = require('./shared/common');
 
 function validateTestRun(done) {
-  common.exec(`node`, [common.cliPath, `e2e`, `--logFormat`, `none`], common.cwdOpts)
+  const args = [
+    common.cliPath,
+    `e2e`,
+    `--logFormat`,
+    `none`,
+    `--sslCert`,
+    common.sslCert,
+    `--sslKey`,
+    common.sslKey
+  ];
+
+  common.exec(`node`, args, common.cwdOpts)
     .then(exit => {
       expect(exit).toEqual(0);
       done();