mirror of
https://github.com/serverless/serverless.git
synced 2026-01-18 14:58:43 +00:00
385 lines
12 KiB
JavaScript
385 lines
12 KiB
JavaScript
'use strict';
|
|
|
|
/**
|
|
* Action: ModuleCreate
|
|
*/
|
|
|
|
const JawsPlugin = require('../../JawsPlugin'),
|
|
JawsError = require('../../jaws-error'),
|
|
JawsCLI = require('../../utils/cli'),
|
|
path = require('path'),
|
|
BbPromise = require('bluebird'),
|
|
JawsUtils = require('../../utils');
|
|
|
|
let fs = require('fs');
|
|
BbPromise.promisifyAll(fs);
|
|
|
|
const supportedRuntimes = {
|
|
nodejs: {
|
|
defaultPkgMgr: 'npm',
|
|
validPkgMgrs: ['npm'],
|
|
},
|
|
};
|
|
|
|
/**
|
|
* ModuleCreate Class
|
|
*/
|
|
|
|
class FunctionCreate extends JawsPlugin {
|
|
|
|
/**
|
|
* @param Jaws class object
|
|
* @param config object
|
|
*/
|
|
|
|
constructor(Jaws, config) {
|
|
super(Jaws, config);
|
|
this._templatesDir = path.join(__dirname, '..', '..', 'templates');
|
|
this.evt = {};
|
|
}
|
|
|
|
/**
|
|
* Define your plugins name
|
|
*
|
|
* @returns {string}
|
|
*/
|
|
static getName() {
|
|
return 'jaws.core.' + FunctionCreate.name;
|
|
}
|
|
|
|
/**
|
|
* @returns {Promise} upon completion of all registrations
|
|
*/
|
|
|
|
registerActions() {
|
|
this.Jaws.addAction(this.functionCreate.bind(this), {
|
|
handler: 'functionCreate',
|
|
description: `Creates scaffolding for a new function.
|
|
usage: jaws function create <function>`,
|
|
context: 'function',
|
|
contextAction: 'create',
|
|
options: [
|
|
{
|
|
option: 'runtime',
|
|
shortcut: 'r',
|
|
description: 'Optional - Runtime of your new module. Default: nodejs'
|
|
},
|
|
{
|
|
option: 'lambda',
|
|
shortcut: 'l',
|
|
description: 'Optional - if true, will create lambda only module. Default: will create both lambda & endpoint'
|
|
},
|
|
{
|
|
option: 'endpoint',
|
|
shortcut: 'e',
|
|
description: 'Optional - if true, will create endpoint only module. Default: will create both lambda & endpoint'
|
|
},
|
|
{
|
|
option: 'package-manager',
|
|
shortcut: 'p',
|
|
description: 'Optional - package manager for your chosen runtime. Default: npm for nodejs'
|
|
},
|
|
{
|
|
option: 'nonInteractive',
|
|
shortcut: 'i',
|
|
description: 'Optional - Turn off CLI interactivity if true. Default: false'
|
|
},
|
|
|
|
],
|
|
});
|
|
return BbPromise.resolve();
|
|
}
|
|
|
|
/**
|
|
* Action
|
|
*/
|
|
functionCreate(evt) {
|
|
let _this = this;
|
|
|
|
if(evt) {
|
|
_this.evt = evt;
|
|
_this.Jaws._interactive = false;
|
|
}
|
|
|
|
// If CLI, parse options & params
|
|
if (_this.Jaws.cli) {
|
|
_this.evt = this.Jaws.cli.options;
|
|
_this.evt.function = _this.Jaws.cli.params[0];
|
|
|
|
if (_this.Jaws.cli.options.nonInteractive) {
|
|
_this.Jaws._interactive = false;
|
|
}
|
|
}
|
|
|
|
return this.Jaws.validateProject()
|
|
.bind(_this)
|
|
.then(_this._promptFunction)
|
|
.then(_this._validateAndPrepare)
|
|
.then(_this._createSkeleton)
|
|
.then(_this._createPackageMgrSkeleton)
|
|
.then(function() {
|
|
JawsCLI.log('Successfully created ' + _this.evt.function + ' function.');
|
|
});
|
|
}
|
|
|
|
|
|
/**
|
|
* Prompt function if it's missing
|
|
*/
|
|
_promptFunction(){
|
|
let _this = this,
|
|
overrides = {};
|
|
|
|
if (!_this.Jaws._interactive) return BbPromise.resolve();
|
|
|
|
['function'].forEach(memberVarKey => {
|
|
overrides[memberVarKey] = _this['evt'][memberVarKey];
|
|
});
|
|
|
|
let prompts = {
|
|
properties: {
|
|
function: {
|
|
description: 'Enter a new function name: '.yellow,
|
|
message: 'Function name is required.',
|
|
required: true,
|
|
}
|
|
}
|
|
};
|
|
|
|
return _this.promptInput(prompts, overrides)
|
|
.then(function(answers) {
|
|
_this.evt.function = answers.function;
|
|
});
|
|
}
|
|
|
|
|
|
_validateAndPrepare() {
|
|
// non interactive validation
|
|
if (!this.Jaws._interactive) {
|
|
|
|
// Check API Keys
|
|
if (!this.Jaws._awsProfile) {
|
|
if (!this.Jaws._awsAdminKeyId || !this.Jaws._awsAdminSecretKey) {
|
|
return BbPromise.reject(new JawsError('Missing AWS Profile and/or API Key and/or AWS Secret Key'));
|
|
}
|
|
}
|
|
// Check Params
|
|
if (!this.evt.function) {
|
|
return BbPromise.reject(new JawsError('Missing function name'));
|
|
}
|
|
}
|
|
|
|
if (!this.evt.lambda && !this.evt.endpoint) { //default is to create both
|
|
this.evt.lambda = true;
|
|
this.evt.endpoint = true;
|
|
}
|
|
|
|
// Add default runtime
|
|
if (!this.evt.runtime) {
|
|
this.evt.runtime = 'nodejs';
|
|
}
|
|
|
|
// add default package manager
|
|
if (!this.evt.pkgMgr){
|
|
this.evt.pkgMgr = supportedRuntimes[this.evt.runtime].defaultPkgMgr;
|
|
}
|
|
|
|
if (!supportedRuntimes[this.evt.runtime]) {
|
|
return BbPromise.reject(new JawsError('Unsupported runtime ' + this.evt.runtime, JawsError.errorCodes.UNKNOWN));
|
|
}
|
|
|
|
if (supportedRuntimes[this.evt.runtime].validPkgMgrs.indexOf(this.evt.pkgMgr) == -1) {
|
|
return BbPromise.reject(new JawsError('Unsupported package manger "' + this.evt.pkgMgr + '"', JawsError.errorCodes.UNKNOWN));
|
|
}
|
|
|
|
// senitize function
|
|
this.evt.function = this.evt.function.toLowerCase().trim()
|
|
.replace(/\s/g, '-')
|
|
.replace(/[^a-zA-Z-\d:]/g, '')
|
|
.substring(0, 19);
|
|
|
|
// get module name from CWD awsm.json
|
|
this.evt.module = JawsUtils.readAndParseJsonSync(path.join(process.cwd(), 'awsm.json')).name;
|
|
|
|
return BbPromise.resolve();
|
|
}
|
|
|
|
_generateFunctionAwsmJson() {
|
|
let _this = this;
|
|
let functionTemplateJson = JawsUtils.readAndParseJsonSync(path.join(this._templatesDir, 'lambda.awsm.json'));
|
|
|
|
//We prefix with an l to make sure the CloudFormation resource map index is unique
|
|
functionTemplateJson.name = _this.evt.module.charAt(0).toUpperCase() + _this.evt.module.slice(1) + _this.evt.function.charAt(0).toUpperCase() + _this.evt.function.slice(1);
|
|
|
|
if (_this.evt.lambda) {
|
|
functionTemplateJson.cloudFormation.lambda.Function.Properties.Runtime = _this.evt.runtime;
|
|
|
|
// Create files for lambda functions
|
|
switch (_this.evt.runtime) {
|
|
case 'nodejs':
|
|
functionTemplateJson.cloudFormation.lambda.Function.Properties.Handler = path.join('slss_modules', _this.evt.module, _this.evt.function, 'handler.handler');
|
|
break;
|
|
default:
|
|
return BbPromise.reject(new JawsError('Unsupported runtime ' + this.evt.runtime, JawsError.errorCodes.UNKNOWN));
|
|
break;
|
|
}
|
|
} else {
|
|
delete functionTemplateJson.lambda;
|
|
}
|
|
|
|
if (_this.evt.endpoint) {
|
|
functionTemplateJson.cloudFormation.apiGateway.Endpoint.Path = _this.evt.module + '/' + _this.evt.function;
|
|
} else {
|
|
delete functionTemplateJson.cloudFormation.apiGateway;
|
|
}
|
|
|
|
delete functionTemplateJson.cloudFormation.lambda.EventSourceMapping;
|
|
delete functionTemplateJson.cloudFormation.lambda.AccessPolicyX;
|
|
|
|
return functionTemplateJson;
|
|
}
|
|
|
|
_generateModuleAwsmJson() {
|
|
let _this = this;
|
|
let moduleTemplateJson = JawsUtils.readAndParseJsonSync(path.join(this._templatesDir, 'module.awsm.json'));
|
|
moduleTemplateJson.name = _this.evt.module;
|
|
return moduleTemplateJson;
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @returns {Promise}
|
|
* @private
|
|
*/
|
|
_createSkeleton() {
|
|
let _this = this,
|
|
writeFilesDeferred = [],
|
|
modulePath = process.cwd(),
|
|
functionPath = path.join(modulePath, _this.evt.function);
|
|
|
|
// If module/function already exists, throw error
|
|
if (JawsUtils.dirExistsSync(functionPath)) {
|
|
return BbPromise.reject(new JawsError(
|
|
functionPath + ' already exists',
|
|
JawsError.errorCodes.INVALID_PROJECT_JAWS
|
|
));
|
|
}
|
|
|
|
//module path will get created by util.writeFile if DNE
|
|
|
|
// If module awsm.json doesn't exist, create it
|
|
if (!JawsUtils.fileExistsSync(path.join(modulePath, 'awsm.json'))) {
|
|
JawsUtils.jawsDebug('Module awsm.json does not exist. Creating..')
|
|
let moduleTemplateJson = _this._generateModuleAwsmJson();
|
|
writeFilesDeferred.push(
|
|
JawsUtils.writeFile(
|
|
path.join(modulePath, 'awsm.json'),
|
|
JSON.stringify(moduleTemplateJson, null, 2)
|
|
)
|
|
);
|
|
}
|
|
|
|
// Create function folder
|
|
writeFilesDeferred.push(fs.mkdirSync(functionPath));
|
|
|
|
// Create function awsm.json
|
|
let functionTemplateJson = _this._generateFunctionAwsmJson(),
|
|
handlerJs = fs.readFileSync(path.join(this._templatesDir, 'nodejs', 'handler.js')),
|
|
indexJs = fs.readFileSync(path.join(this._templatesDir, 'nodejs', 'index.js'));
|
|
|
|
writeFilesDeferred.push(
|
|
JawsUtils.writeFile(path.join(functionPath, 'handler.js'), handlerJs),
|
|
JawsUtils.writeFile(path.join(functionPath, 'index.js'), indexJs),
|
|
JawsUtils.writeFile(path.join(functionPath, 'event.json'), '{}'),
|
|
JawsUtils.writeFile(path.join(functionPath, 'lambda.awsm.json'), JSON.stringify(functionTemplateJson, null, 2))
|
|
);
|
|
|
|
return BbPromise.all(writeFilesDeferred);
|
|
}
|
|
|
|
|
|
/**
|
|
*
|
|
* @returns {Promise}
|
|
* @private
|
|
*/
|
|
_createPackageMgrSkeleton() {
|
|
let _this = this,
|
|
deferredWrites = [];
|
|
|
|
switch (_this.evt.runtime) {
|
|
case 'nodejs':
|
|
if (_this.evt.pkgMgr == 'npm') {
|
|
let node_modules_path = path.join(_this.Jaws._projectRootPath, 'back', 'node_modules');
|
|
|
|
// Create node_modules if DNE in project
|
|
if (!JawsUtils.dirExistsSync(node_modules_path)) {
|
|
deferredWrites.push(fs.mkdirAsync(node_modules_path));
|
|
}
|
|
|
|
let modulePath = path.join(_this.Jaws._projectRootPath, 'back', 'node_modules', _this.evt.module);
|
|
|
|
// create module dir if DNE in node_modules
|
|
if (!JawsUtils.dirExistsSync(modulePath)) {
|
|
deferredWrites.push(fs.mkdirAsync(modulePath));
|
|
}
|
|
|
|
// Create module package.json if DNE in node_module
|
|
if (!JawsUtils.fileExistsSync(path.join(modulePath, 'package.json'))) {
|
|
let packageJsonTemplate = JawsUtils.readAndParseJsonSync(path.join(_this._templatesDir, 'nodejs', 'package.json'));
|
|
packageJsonTemplate.name = _this.evt.module;
|
|
packageJsonTemplate.description = 'An aws-module';
|
|
packageJsonTemplate.dependencies = {};
|
|
|
|
deferredWrites.push(
|
|
fs.writeFileAsync(path.join(modulePath, 'package.json'), JSON.stringify(packageJsonTemplate, null, 2))
|
|
);
|
|
}
|
|
|
|
// Create module awsm.json if DNE in node_module
|
|
if (!JawsUtils.fileExistsSync(path.join(modulePath, 'awsm.json'))) {
|
|
let moduleTemplateJson = _this._generateModuleAwsmJson();
|
|
deferredWrites.push(
|
|
JawsUtils.writeFile(path.join(modulePath, 'awsm.json'),
|
|
JSON.stringify(moduleTemplateJson, null, 2)));
|
|
}
|
|
|
|
// Create root lib folder if DNE in node_module
|
|
let modLibPath = path.join(modulePath, 'lib');
|
|
if (!JawsUtils.dirExistsSync(modLibPath)) {
|
|
deferredWrites.push(fs.mkdirAsync(modLibPath));
|
|
}
|
|
|
|
// Create awsm folder if DNE in node_module
|
|
if (!JawsUtils.dirExistsSync(path.join(modulePath, 'awsm'))) {
|
|
deferredWrites.push(fs.mkdirAsync(path.join(modulePath, 'awsm')));
|
|
}
|
|
|
|
// Create function if DNE in node_module
|
|
let functionPath = path.join(modulePath, 'awsm', _this.evt.function);
|
|
if (!JawsUtils.dirExistsSync(functionPath)) {
|
|
|
|
let functionTemplateJson = _this._generateFunctionAwsmJson(),
|
|
handlerJs = fs.readFileSync(path.join(_this._templatesDir, 'nodejs', 'handler.js')),
|
|
indexJs = fs.readFileSync(path.join(_this._templatesDir, 'nodejs', 'index.js'));
|
|
|
|
deferredWrites.push(
|
|
JawsUtils.writeFile(path.join(functionPath, 'lambda.awsm.json'), JSON.stringify(functionTemplateJson, null, 2)),
|
|
JawsUtils.writeFile(path.join(functionPath, 'handler.js'), handlerJs),
|
|
JawsUtils.writeFile(path.join(functionPath, 'index.js'), indexJs),
|
|
JawsUtils.writeFile(path.join(functionPath, 'event.json'), '{}')
|
|
);
|
|
}
|
|
}
|
|
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
return BbPromise.all(deferredWrites);
|
|
}
|
|
}
|
|
|
|
|
|
module.exports = FunctionCreate;
|