archive-gh-me/serverless
1
0
Fork 0
mirror of https://github.com/serverless/serverless.git synced 2026-01-25 15:07:39 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #6719 from mcjfunk/pluginRegistry

Browse Source 
Allow plugins not in registry to be installed
This commit is contained in:
Philipp Muens 2019-09-23 15:12:29 +02:00 committed by GitHub
commit e0da27d1dd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 74 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
lib/plugins/plugin/install/install.js
View File

@ -7,8 +7,8 @@ const path = require('path');
const _ = require('lodash');
const userStats = require('../../../utils/userStats');
const yamlAstParser = require('../../../utils/yamlAstParser');
const pluginUtils = require('../lib/utils');
const fileExists = require('../../../utils/fs/fileExists');
const pluginUtils = require('../lib/utils');
class PluginInstall {
constructor(serverless, options) {
@ -43,13 +43,7 @@ class PluginInstall {
}
install() {
let pluginInfo;
if (this.options.name.startsWith('@')) {
pluginInfo = _.split(this.options.name.slice(1), '@', 2);
pluginInfo[0] = `@${pluginInfo[0]}`;
} else {
pluginInfo = _.split(this.options.name, '@', 2);
}
const pluginInfo = pluginUtils.getPluginInfo(this.options.name);
this.options.pluginName = pluginInfo[0];
this.options.pluginVersion = pluginInfo[1] || 'latest';
@ -58,21 +52,20 @@ class PluginInstall {
.then(this.getPlugins)
.then(plugins => {
const plugin = plugins.find(item => item.name === this.options.pluginName);
if (plugin) {
return BbPromise.bind(this)
.then(this.pluginInstall)
.then(this.addPluginToServerlessFile)
.then(this.installPeerDependencies)
.then(() => {
const message = [
'Successfully installed',
` "${this.options.pluginName}@${this.options.pluginVersion}"`,
].join('');
this.serverless.cli.log(message);
});
if (!plugin) {
this.serverless.cli.log('Plugin not found in serverless registry, continuing to install');
}
const message = `Plugin "${this.options.pluginName}" not found. Did you spell it correct?`;
throw new this.serverless.classes.Error(message);
return BbPromise.bind(this)
.then(this.pluginInstall)
.then(this.addPluginToServerlessFile)
.then(this.installPeerDependencies)
.then(() => {
const message = [
'Successfully installed',
` "${this.options.pluginName}@${this.options.pluginVersion}"`,
].join('');
this.serverless.cli.log(message);
});
});
}

16
lib/plugins/plugin/install/install.test.js
View File

@ -178,7 +178,7 @@ describe('PluginInstall', () => {
});
});
it('should not install the plugin if it can not be found in the registry', () => {
it('should install the plugin even if it can not be found in the registry', () => {
// serverless.yml
const serverlessYml = {
service: 'plugin-service',
@ -186,15 +186,15 @@ describe('PluginInstall', () => {
};
serverless.utils.writeFileSync(serverlessYmlFilePath, YAML.dump(serverlessYml));
pluginInstall.options.name = 'serverless-not-available-plugin';
return expect(pluginInstall.install()).to.be.rejected.then(() => {
pluginInstall.options.name = 'serverless-not-in-registry-plugin';
return expect(pluginInstall.install()).to.be.fulfilled.then(() => {
expect(validateStub.calledOnce).to.equal(true);
expect(getPluginsStub.calledOnce).to.equal(true);
expect(pluginInstallStub.calledOnce).to.equal(false);
expect(consoleLogStub.called).to.equal(false);
expect(serverlessErrorStub.calledOnce).to.equal(true);
expect(addPluginToServerlessFileStub.calledOnce).to.equal(false);
expect(installPeerDependenciesStub.calledOnce).to.equal(false);
expect(pluginInstallStub.calledOnce).to.equal(true);
expect(consoleLogStub.called).to.equal(true);
expect(serverlessErrorStub.calledOnce).to.equal(false);
expect(addPluginToServerlessFileStub.calledOnce).to.equal(true);
expect(installPeerDependenciesStub.calledOnce).to.equal(true);
});
});

11
lib/plugins/plugin/lib/utils.js
View File

@ -69,6 +69,17 @@ module.exports = {
.then(json => json);
},
getPluginInfo(name) {
let pluginInfo;
if (name.startsWith('@')) {
pluginInfo = _.split(name.slice(1), '@', 2);
pluginInfo[0] = `@${pluginInfo[0]}`;
} else {
pluginInfo = _.split(name, '@', 2);
}
return pluginInfo;
},
display(plugins) {
let message = '';
if (plugins && plugins.length) {

17
lib/plugins/plugin/lib/utils.test.js
View File

@ -149,6 +149,23 @@ describe('PluginUtils', () => {
});
});
describe('#getPluginInfo()', () => {
it('should return the plugins name', () => {
expect(pluginUtils.getPluginInfo('some-plugin')).to.deep.equal(['some-plugin']);
});
it('should return the plugins name and version', () => {
expect(pluginUtils.getPluginInfo('some-plugin@0.1.0')).to.deep.equal([
'some-plugin',
'0.1.0',
]);
});
it('should support scoped names', () => {
expect(pluginUtils.getPluginInfo('@acme/some-plugin')).to.deep.equal(['@acme/some-plugin']);
});
});
describe('#display()', () => {
it('should display the plugins if present', () => {
let expectedMessage = '';

27
lib/plugins/plugin/uninstall/uninstall.js
View File

@ -5,9 +5,9 @@ const childProcess = BbPromise.promisifyAll(require('child_process'));
const fse = require('../../../utils/fs/fse');
const path = require('path');
const _ = require('lodash');
const pluginUtils = require('../lib/utils');
const userStats = require('../../../utils/userStats');
const yamlAstParser = require('../../../utils/yamlAstParser');
const pluginUtils = require('../lib/utils');
class PluginUninstall {
constructor(serverless, options) {
@ -43,7 +43,7 @@ class PluginUninstall {
}
uninstall() {
const pluginInfo = _.split(this.options.name, '@', 2);
const pluginInfo = pluginUtils.getPluginInfo(this.options.name);
this.options.pluginName = pluginInfo[0];
return BbPromise.bind(this)
@ -51,18 +51,19 @@ class PluginUninstall {
.then(this.getPlugins)
.then(plugins => {
const plugin = plugins.find(item => item.name === this.options.pluginName);
if (plugin) {
return BbPromise.bind(this)
.then(this.uninstallPeerDependencies)
.then(this.pluginUninstall)
.then(this.removePluginFromServerlessFile)
.then(() => {
this.serverless.cli.log(`Successfully uninstalled "${this.options.pluginName}"`);
return BbPromise.resolve();
});
if (!plugin) {
this.serverless.cli.log(
'Plugin not found in serverless registry, continuing to uninstall'
);
}
const message = `Plugin "${this.options.pluginName}" not found. Did you spell it correct?`;
throw new this.serverless.classes.Error(message);
return BbPromise.bind(this)
.then(this.uninstallPeerDependencies)
.then(this.pluginUninstall)
.then(this.removePluginFromServerlessFile)
.then(() => {
this.serverless.cli.log(`Successfully uninstalled "${this.options.pluginName}"`);
return BbPromise.resolve();
});
});
}

17
lib/plugins/plugin/uninstall/uninstall.test.js
View File

@ -155,7 +155,7 @@ describe('PluginUninstall', () => {
});
});
it('should not uninstall the plugin if it can not be found in the registry', () => {
it('should uninstall the plugin even if it can not be found in the registry', () => {
// serverless.yml
const serverlessYml = {
service: 'plugin-service',
@ -163,15 +163,16 @@ describe('PluginUninstall', () => {
};
serverless.utils.writeFileSync(serverlessYmlFilePath, YAML.dump(serverlessYml));
pluginUninstall.options.name = 'serverless-not-available-plugin';
return expect(pluginUninstall.uninstall()).to.be.rejected.then(() => {
pluginUninstall.options.name = 'serverless-not-in-registry-plugin';
return expect(pluginUninstall.uninstall()).to.be.fulfilled.then(() => {
expect(validateStub.calledOnce).to.equal(true);
expect(getPluginsStub.calledOnce).to.equal(true);
expect(pluginUninstallStub.calledOnce).to.equal(false);
expect(consoleLogStub.called).to.equal(false);
expect(serverlessErrorStub.calledOnce).to.equal(true);
expect(removePluginFromServerlessFileStub.calledOnce).to.equal(false);
expect(uninstallPeerDependenciesStub.calledOnce).to.equal(false);
expect(pluginUninstallStub.calledOnce).to.equal(true);
expect(consoleLogStub.called).to.equal(true);
expect(serverlessErrorStub.calledOnce).to.equal(false);
expect(removePluginFromServerlessFileStub.calledOnce).to.equal(true);
expect(uninstallPeerDependenciesStub.calledOnce).to.equal(true);
});
});