mirror of
https://github.com/inspec/inspec
synced 2024-11-26 06:30:26 +00:00
linting
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
This commit is contained in:
Clinton Wolfe
parent
5acbae42ee
commit
4582f1f8a7
2 changed files with 94 additions and 91 deletions
|
|
@ -5,7 +5,6 @@ require_relative 'renderer'
|
|||
module InspecPlugins
|
||||
module Init
|
||||
class CLI < Inspec.plugin(2, :cli_command)
|
||||
|
||||
#-------------------------------------------------------------------#
|
||||
# inspec init plugin
|
||||
#-------------------------------------------------------------------#
|
||||
|
|
@ -28,20 +27,8 @@ module InspecPlugins
|
|||
option :plugin_name, type: :string, default: '', hide: true # This is here to give a uniform interface
|
||||
option :copyright, type: :string, default: nil, desc: 'A copyright statement, to be added to LICENSE'
|
||||
|
||||
|
||||
def plugin(plugin_name)
|
||||
plugin_type = plugin_name.match(/^(inspec|train)\-/)
|
||||
unless plugin_type
|
||||
ui.error("Plugin names must begin with either " + ui.emphasis('inspec') + ' or ' + ui.emphasis('train') + ' - saw ' + ui.emphasis(plugin_name))
|
||||
ui.exit(:usage_error)
|
||||
end
|
||||
options[:plugin_name] = plugin_name
|
||||
|
||||
plugin_type = plugin_type[1]
|
||||
unless plugin_type == 'inspec'
|
||||
ui.error('Sorry, only inspec plugins are supported at this time: train support is not implemented yet.')
|
||||
ui.exit(:usage_error)
|
||||
end
|
||||
plugin_type = determine_plugin_type(plugin_name)
|
||||
snake_case = plugin_name.tr('-', '_')
|
||||
|
||||
template_vars = {
|
||||
|
|
@ -52,20 +39,10 @@ module InspecPlugins
|
|||
|
||||
template_path = File.join('plugins', plugin_type + '-plugin-template')
|
||||
|
||||
rename_map = {
|
||||
'inspec-plugin-template.gemspec' => plugin_name + '.gemspec',
|
||||
File.join('lib', 'inspec-plugin-template') => File.join('lib', plugin_name),
|
||||
File.join('lib', 'inspec-plugin-template.rb') => File.join('lib', plugin_name + '.rb'),
|
||||
File.join('lib', 'inspec-plugin-template', 'cli_command.rb') => File.join('lib', plugin_name, 'cli_command.rb'),
|
||||
File.join('lib', 'inspec-plugin-template', 'plugin.rb') => File.join('lib', plugin_name, 'plugin.rb'),
|
||||
File.join('lib', 'inspec-plugin-template', 'version.rb') => File.join('lib', plugin_name, 'version.rb'),
|
||||
File.join('test', 'functional', 'inspec_plugin_template_test.rb') => File.join('test', 'functional', snake_case + '_test.rb'),
|
||||
}
|
||||
|
||||
render_opts = {
|
||||
templates_path: TEMPLATES_PATH,
|
||||
overwrite: options[:overwrite],
|
||||
file_rename_map: rename_map,
|
||||
file_rename_map: make_rename_map(plugin_type, plugin_name, snake_case),
|
||||
skip_files: make_skip_list,
|
||||
}
|
||||
renderer = InspecPlugins::Init::Renderer.new(ui, render_opts)
|
||||
|
|
@ -74,18 +51,44 @@ module InspecPlugins
|
|||
end
|
||||
|
||||
private
|
||||
|
||||
def determine_plugin_type(plugin_name)
|
||||
plugin_type = plugin_name.match(/^(inspec|train)\-/)
|
||||
unless plugin_type
|
||||
ui.error('Plugin names must begin with either ' + ui.emphasis('inspec') + ' or ' + ui.emphasis('train') + ' - saw ' + ui.emphasis(plugin_name))
|
||||
ui.exit(:usage_error)
|
||||
end
|
||||
options[:plugin_name] = plugin_name
|
||||
|
||||
plugin_type = plugin_type[1]
|
||||
unless plugin_type == 'inspec'
|
||||
ui.error('Sorry, only inspec plugins are supported at this time: train support is not implemented yet.')
|
||||
ui.exit(:usage_error)
|
||||
end
|
||||
plugin_type
|
||||
end
|
||||
|
||||
def make_rename_map(_plugin_type, plugin_name, snake_case)
|
||||
{
|
||||
'inspec-plugin-template.gemspec' => plugin_name + '.gemspec',
|
||||
File.join('lib', 'inspec-plugin-template') => File.join('lib', plugin_name),
|
||||
File.join('lib', 'inspec-plugin-template.rb') => File.join('lib', plugin_name + '.rb'),
|
||||
File.join('lib', 'inspec-plugin-template', 'cli_command.rb') => File.join('lib', plugin_name, 'cli_command.rb'),
|
||||
File.join('lib', 'inspec-plugin-template', 'plugin.rb') => File.join('lib', plugin_name, 'plugin.rb'),
|
||||
File.join('lib', 'inspec-plugin-template', 'version.rb') => File.join('lib', plugin_name, 'version.rb'),
|
||||
File.join('test', 'functional', 'inspec_plugin_template_test.rb') => File.join('test', 'functional', snake_case + '_test.rb'),
|
||||
}
|
||||
end
|
||||
|
||||
def plugin_vars_from_opts
|
||||
# Set dynamic defaults
|
||||
# Set dynamic default - module name is straightforward. Copyright, homepage, and license_text depend on other prompted vars.
|
||||
options[:module_name] ||= options[:plugin_name].sub(/^(inspec|train)\-/, '').split('-').map(&:capitalize).join('')
|
||||
# Also set copyright and homepage, but that may be prompted
|
||||
|
||||
if options[:prompt] && ui.interactive?
|
||||
vars = options.dup.merge(vars_from_prompts)
|
||||
elsif !options[:prompt]
|
||||
options[:copyright] ||= 'Copyright © ' + Date.today.year.to_s + ' ' + options[:author_name]
|
||||
options[:homepage] ||= 'https://github.com/' + options[:author_email].split('@').first + '/' + options[:plugin_name]
|
||||
options[:license_text] = fetch_license_text(options[:license_name])
|
||||
vars = options.dup
|
||||
vars = options.dup.merge(vars_from_defaults)
|
||||
|
||||
else
|
||||
ui.error('You requested interactive prompting for the template variables, but this does not seem to be an interactive terminal.')
|
||||
ui.exit(:usage_error)
|
||||
|
|
@ -93,31 +96,47 @@ module InspecPlugins
|
|||
vars.merge(parse_hook_option(options[:hook]))
|
||||
end
|
||||
|
||||
def vars_from_defaults
|
||||
options[:copyright] ||= 'Copyright © ' + Date.today.year.to_s + ' ' + options[:author_name]
|
||||
options[:homepage] ||= 'https://github.com/' + options[:author_email].split('@').first + '/' + options[:plugin_name]
|
||||
options[:license_text] = fetch_license_text(options[:license_name])
|
||||
options
|
||||
end
|
||||
|
||||
def vars_from_prompts
|
||||
option_defs = self.class.all_commands['plugin'].options
|
||||
order = {
|
||||
:author_name => {},
|
||||
:author_email => {},
|
||||
:summary => {},
|
||||
:description => { mode: :multiline },
|
||||
:module_name => {},
|
||||
:copyright => { default_setter: Proc.new { options[:copyright] ||= 'Copyright © ' + Date.today.year.to_s + ' ' + options[:author_name] } },
|
||||
:license_name => {
|
||||
author_name: {},
|
||||
author_email: {},
|
||||
summary: {},
|
||||
description: { mode: :multiline },
|
||||
module_name: {},
|
||||
copyright: { default_setter: proc { options[:copyright] ||= 'Copyright © ' + Date.today.year.to_s + ' ' + options[:author_name] } },
|
||||
license_name: {
|
||||
mode: :select,
|
||||
choices: [
|
||||
{ name: 'Apache 2.0', value: 'Apache-2.0', default: true, },
|
||||
{ name: 'Modified BSD', value: 'BSD-3-Clause', },
|
||||
{ name: 'Proprietary (Closed Source)', value: 'Proprietary', },
|
||||
{ name: 'Other (edit LICENSE yourself)', value: 'Other', },
|
||||
]
|
||||
{ name: 'Apache 2.0', value: 'Apache-2.0', default: true },
|
||||
{ name: 'Modified BSD', value: 'BSD-3-Clause' },
|
||||
{ name: 'Proprietary (Closed Source)', value: 'Proprietary' },
|
||||
{ name: 'Other (edit LICENSE yourself)', value: 'Other' },
|
||||
],
|
||||
},
|
||||
:homepage => { default_setter: Proc.new { options[:homepage] ||= 'https://github.com/' + options[:author_email].split('@').first + '/' + options[:plugin_name] } }
|
||||
homepage: { default_setter: proc { options[:homepage] ||= 'https://github.com/' + options[:author_email].split('@').first + '/' + options[:plugin_name] } }
|
||||
# TODO: Handle hooks, when we ever have more than one type of plugin
|
||||
}
|
||||
|
||||
order.each do |opt_name, prompt_options|
|
||||
prompt_for_options(order)
|
||||
|
||||
options[:license_text] = fetch_license_text(options[:license_name])
|
||||
|
||||
options
|
||||
end
|
||||
|
||||
def prompt_for_options(option_order) # rubocop: disable Metrics/AbcSize
|
||||
option_defs = self.class.all_commands['plugin'].options
|
||||
|
||||
option_order.each do |opt_name, prompt_options|
|
||||
opt_def = option_defs[opt_name]
|
||||
prompt_options[:default_setter].call if prompt_options[:default_setter]
|
||||
prompt_options[:default_setter]&.call
|
||||
|
||||
case prompt_options[:mode]
|
||||
when :select
|
||||
|
|
@ -129,10 +148,6 @@ module InspecPlugins
|
|||
options[opt_name] = ui.prompt.ask('Enter ' + opt_def.description + ':', default: options[opt_name])
|
||||
end
|
||||
end
|
||||
|
||||
options[:license_text] = fetch_license_text(options[:license_name])
|
||||
|
||||
options
|
||||
end
|
||||
|
||||
def parse_hook_option(raw_option)
|
||||
|
|
@ -159,40 +174,30 @@ module InspecPlugins
|
|||
def fetch_license_text(license_name)
|
||||
case license_name
|
||||
when 'Proprietary'
|
||||
return <<~EOL
|
||||
|
||||
Proprietary software. All Rights Reserved.
|
||||
<<~EOL
|
||||
Proprietary software. All Rights Reserved.
|
||||
EOL
|
||||
when 'Apache-2.0'
|
||||
return <<~EOL
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
<<~EOL
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
||||
EOL
|
||||
when 'BSD-3-Clause'
|
||||
return <<~EOL
|
||||
|
||||
Modified BSD License
|
||||
|
||||
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
||||
|
||||
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
<<~EOL
|
||||
Modified BSD License
|
||||
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
||||
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
||||
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
||||
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
EOL
|
||||
else
|
||||
'"Other" license selected at plugin generation time - please insert your license here.'
|
||||
|
|
@ -216,15 +221,15 @@ module InspecPlugins
|
|||
'inspec-plugin-template.gemspec',
|
||||
'LICENSE',
|
||||
'Rakefile',
|
||||
File.join('test','fixtures','README.md'),
|
||||
File.join('test','fixtures'),
|
||||
File.join('test','functional','inspec_plugin_template_test.rb'),
|
||||
File.join('test','functional','README.md'),
|
||||
File.join('test','unit','cli_args_test.rb'),
|
||||
File.join('test','unit','plugin_def_test.rb'),
|
||||
File.join('test','unit','README.md'),
|
||||
File.join('test','unit'),
|
||||
File.join('test','helper.rb'),
|
||||
File.join('test', 'fixtures', 'README.md'),
|
||||
File.join('test', 'fixtures'),
|
||||
File.join('test', 'functional', 'inspec_plugin_template_test.rb'),
|
||||
File.join('test', 'functional', 'README.md'),
|
||||
File.join('test', 'unit', 'cli_args_test.rb'),
|
||||
File.join('test', 'unit', 'plugin_def_test.rb'),
|
||||
File.join('test', 'unit', 'README.md'),
|
||||
File.join('test', 'unit'),
|
||||
File.join('test', 'helper.rb'),
|
||||
File.join('test'),
|
||||
]
|
||||
else
|
||||
|
|
|
|||
|
|
@ -6,8 +6,6 @@ require_relative 'renderer'
|
|||
module InspecPlugins
|
||||
module Init
|
||||
class CLI < Inspec.plugin(2, :cli_command)
|
||||
|
||||
|
||||
#-------------------------------------------------------------------#
|
||||
# inspec init profile
|
||||
#-------------------------------------------------------------------#
|
||||
|
|
|
|||
Loading…
Reference in a new issue