[Live Now] Join the 1-day Testing & QA Summit featuring 15+ Expert Speakers.Join for FREE! Join TestMu Conference

How to use description method of Inspec Package

Best Inspec_ruby code snippet using Inspec.description

xccdf2inspec.rb

Source:xccdf2inspec.rb

...46    @xccdf_controls.group.each do |group|47      control = Inspec::Control.new48      control.id     = group.id49      control.title  = group.rule.title50      control.desc   = group.rule.description.vuln_discussion.split('Satisfies: ')[0]51      control.impact = get_impact(group.rule.severity)52      control.add_tag(Inspec::Tag.new('gtitle', group.title))53      control.add_tag(Inspec::Tag.new('satisfies', group.rule.description.vuln_discussion.split('Satisfies: ')[1].split(',').map(&:strip))) if group.rule.description.vuln_discussion.split('Satisfies: ').length > 154      control.add_tag(Inspec::Tag.new('gid',      group.id))55      control.add_tag(Inspec::Tag.new('rid',      group.rule.id))56      control.add_tag(Inspec::Tag.new('stig_id',  group.rule.version))57      control.add_tag(Inspec::Tag.new('fix_id', group.rule.fix.id))58      control.add_tag(Inspec::Tag.new('cci', group.rule.idents))59      control.add_tag(Inspec::Tag.new('nist', @cci_items.fetch_nists(group.rule.idents)))60      control.add_tag(Inspec::Tag.new('false_negatives', group.rule.description.false_negatives)) if group.rule.description.false_negatives != ''61      control.add_tag(Inspec::Tag.new('false_positives', group.rule.description.false_positives)) if group.rule.description.false_positives != ''62      control.add_tag(Inspec::Tag.new('documentable', group.rule.description.documentable)) if group.rule.description.documentable != ''63      control.add_tag(Inspec::Tag.new('mitigations', group.rule.description.false_negatives)) if group.rule.description.mitigations != ''64      control.add_tag(Inspec::Tag.new('severity_override_guidance', group.rule.description.severity_override_guidance)) if group.rule.description.severity_override_guidance != ''65      control.add_tag(Inspec::Tag.new('potential_impacts', group.rule.description.potential_impacts)) if group.rule.description.potential_impacts != ''66      control.add_tag(Inspec::Tag.new('third_party_tools', group.rule.description.third_party_tools)) if group.rule.description.third_party_tools != ''67      control.add_tag(Inspec::Tag.new('mitigation_controls', group.rule.description.mitigation_controls)) if group.rule.description.mitigation_controls != ''68      control.add_tag(Inspec::Tag.new('responsibility', group.rule.description.responsibility)) if group.rule.description.responsibility != ''69      control.add_tag(Inspec::Tag.new('ia_controls', group.rule.description.ia_controls)) if group.rule.description.ia_controls != ''70      control.add_tag(Inspec::Tag.new('check', group.rule.check.check_content))71      control.add_tag(Inspec::Tag.new('fix', group.rule.fixtext))72      @controls << control73    end74  end75  def generate_controls76    Dir.mkdir @output.to_s unless Dir.exist?(@output.to_s)77    Dir.mkdir "#{@output}/controls" unless Dir.exist?("#{@output}/controls")78    Dir.mkdir "#{@output}/libaries" unless Dir.exist?("#{@output}/libraries")79    myfile = File.new("#{@output}/README.md", 'w')80    myfile.puts "# Example InSpec Profile\n\nthis example shows the implementation of an InSpec profile."81    if @seperated82      if @format == 'ruby'83        @controls.each do |control|...

Rakefile

Source:Rakefile

...48    next unless obj.visibility == :public49    doc_data[obj.name.to_s] = {}50    doc_data[obj.name.to_s]["prefix"] = obj.name.to_s51    doc_data[obj.name.to_s]["body"] = obj.name.to_s52    doc_data[obj.name.to_s]["description"] = obj.docstring53    doc_data[obj.name.to_s]["scope"] = "source.ruby.chef"54    unless doc_data[obj.name.to_s]["description"].end_with?('.')55      doc_data[obj.name.to_s]["description"] << '.'56    end57    if obj.has_tag?('since')58      doc_data[obj.name.to_s]["description"] << " Introduced in Chef Infra Client #{obj.tag('since').text}."59    end60  end61  File.open("../snippets/automated_dsl_snippets.json", "w") do |f|62    f.write(JSON.pretty_generate(doc_data.sort.to_h))63  end64  Rake::Task["generate_inspec_snippets"].invoke65end66task default: :generate_snippets67desc 'Generate InSpec snippets from published resource documentation'68task :generate_inspec_snippets do69  require 'json'70  puts 'Running task generate_inspec_snippets'71  puts 'generate_inspec_snippets :: Validating that InSpec git repository is available locally and up to date.'72  # The InSpec/InSpec repository is used to generate snippets from docs73  if Dir.exist?('inspec')74    # If the inspec directory exists, cd to it and pull to make sure it is up to date75    system('cd inspec ; git pull')76  else77    system('git clone https://github.com/inspec/inspec')78  end79  resources_content = {}80  puts 'generate_inspec_snippets :: Processing resources'81  Dir.glob('inspec/docs-chef-io/content/inspec/resources/*.md').sort.each do |doc_file|82    doc_file_content = File.read(doc_file)83    doc_file_name = doc_file.split('/').last.split('.').first84    # Skip any docs that start with "_" (such as _index)85    next if doc_file_name =~ /^\_.*/86    resource_description = doc_file_content.match(/Use the.*/)87    # Grab the first syntax example from the Markdown file88    resource_example = doc_file_content.match(/(describe.*[\s\S]*?end)$/)[0].gsub("\n      ", "\n\t").gsub("\n    end", "\nend")89    # Build the snippet for this resource90    resource_output_content = {91      'prefix' => doc_file_name,92      'body' => resource_example,93      'description' => resource_description,94      'scope' => 'source.ruby.chef_inspec',95    }96    # Save the parsed resource to the resources_content hash to be written later97    resources_content[doc_file_name] = resource_output_content98  end99  file_content = JSON.pretty_generate(resources_content)100  puts 'generate_inspec_snippets :: Saving Updates to ../snippets/chef_inspec_resources.json'101  File.write('../snippets/chef_inspec_resources.json', file_content)102end...

inspec_exec.rb

Source:inspec_exec.rb

...3#4resource_name :inspec_exec5provides :inspec_exec6unified_mode true if respond_to?(:unified_mode)7description 'Use the **inspec_exec** resource to execute Chef Inspec tests from within the cookbook'8property :path, String, name_property: true,9  description: 'Options to pass to the package resource for the update function.'10property :inspec_exec, String,11  description: 'Optional path to specify source of the Inspec executable.'12property :save_results, [true, false, nil], default: true,13  description: 'Results should be saved to local filesystem.'14property :results_path, String,15  description: 'Location to save result files.'16property :results_reporter, String, default: 'yaml',17  description: 'Format to use for Inspec results, available options are html, json, json-min, json-rspec, junit, yaml.'18action :run do19  # Find the path to the Inspec executable on the system20  # Use the provided path, if available21  inspec_bin = if new_resource.inspec_exec && ::File.exist?(new_resource.inspec_exec)22                 new_resource.inspec_exec23               elsif ::File.exist?('/opt/chef/bin/inspec')24                 '/opt/chef/bin/inspec'25               elsif ::File.exist?('/opt/chef-workstation/bin/inspec')26                 '/opt/chef-workstation/bin/inspec'27               elsif shell_out('hab pkg list --all').stdout.match?(%r{chef/inspec})28                 'hab pkg exec chef/inspec inspec'29               end30  raise 'Could not find the Inspec executable' unless !inspec_bin.nil?31  log "Using Inspec binary located at: #{inspec_bin}"...

description

Using AI Code Generation

1describe file('/etc/passwd') do2    it { should be_file }3Profile: tests from 1.rb (tests from 1.rb)4Version: (not specified)5Profile: tests from 1.rb (tests from 1.rb)6Version: (not specified)7Profile: tests from 1.rb (tests from 1.rb)8Version: (not specified)9Profile: tests from 1.rb (tests from 1.rb)10Version: (not specified)11Profile: tests from 1.rb (tests from 1.rb)12Version: (not specified)

description

Using AI Code Generation

1  describe file('/etc/passwd') do2    it { should be_file }3  describe file('/etc/passwd') do4    it { should be_file }5{"version":"1.1.0","profiles":[{"name":"1","title":"Test 1","maintainer":null,"copyright":null,"license":null,"summary":null,"version":"0.1.0","supports":[],"controls":[{"id":"1","title":"Test 1","desc":"This is a test description","impact":1.0,"refs":[],"tags":{},"code":"describe file('/etc/passwd') do\n  it { should be_file }\nend\n","source_location":{"ref":"1.rb","line":5},"results":[{"status":"passed","code_desc":"File /etc/passwd should be file","run_time":0.0002,"start_time":"2016-09-26 22:09:25 -0400"}]}]},{"name":"2","title":"Test 2","maintainer":null,"copyright":null,"license":null,"summary":null,"version":"0.1.0","supports":[],"controls":[{"id":"2","title":"Test 2","desc":"This is a test description","impact":1.0,"refs":[],"tags":{},"code":"describe file('/etc/passwd') do\n  it { should be_file }\nend\n","source_location":{"ref":"2.rb","line":5},"results":[{"status":"passed","code_desc":"File /etc/passwd should be file","run_time":0.0002,"start_time":"2016-09-26 22:09:25 -0400"}]}]}],"platform":{"name":null,"release":null},"statistics":{"duration":0.0004}}

description

Using AI Code Generation

1  describe file('/etc/passwd') do2    its('content') { should match(/root:x:0:0:root/) }3  describe file('/etc/passwd') do4    its('content') { should match(/root:x:0:0:root/) }5  describe file('/etc/passwd') do6    its('content') { should match(/root:x:0:0:root/) }7  describe file('/etc/passwd') do8    its('content') { should match(/root:x:0:0:root/) }9  describe file('/etc/passwd') do10    its('content') { should match(/root:x:0:0:root/) }11  describe file('/etc/passwd') do12    its('content') { should match(/root:x:0:0:root/) }13  describe file('/etc/passwd') do

description

Using AI Code Generation

1    its('description') { should eq 'This control checks the description method of the Inspec class' }2    its('description') { should eq 'This control checks the description method of the Control class' }3    its('description') { should eq 'This control checks the description method of the Rule class' }4  describe file('test.txt') do5    its('description') { should eq 'This control checks the description method of the Resource class' }6  describe file('test.txt') do7    its('content') { should eq 'This control checks the description method of the Matcher class' }

description

Using AI Code Generation

1  describe kernel_module('cramfs') do2    it { should_not be_loaded }3  Volume Manager (VxFS) file system. It is recommended that this file system4  describe kernel_module('freevxfs') do5    it { should_not be_loaded }6  describe kernel_module('jffs2') do7    it { should_not be_loaded }8  describe kernel_module('hfs') do9    it { should_not be_loaded }10  describe kernel_module('hfsplus') do11    it { should_not be_loaded }

description

Using AI Code Generation

1    it { should eq 'Inspec Profile' }2    it { should eq 'Inspec Profile' }3    it { should eq 'Inspec Profile' }4    it { should eq 'Inspec Profile' }5    it { should eq 'Inspec Profile' }6    it { should eq 'Inspec Profile' }

description

Using AI Code Generation

1    its('content') { should match(/root:x:0:0:root/) }2  describe file('/etc/passwd') do3    its('content') { should match(/root:x:0:0:root/) }4  describe file('/etc/passwd') do5    its('content') { should match(/root:x:0:0:root/) }6  describe file('/etc/passwd') do7    its('content') { should match(/root:x:0:0:root/) }8  describe file('/etc/passwd') do9    its('content') { should match(/root:x:0:0:root/) }10  describe file('/etc/passwd') do11    its('content') { should match(/root:x:0:0:root/) }12  describe file('/etc/passwd') do

description

Using AI Code Generation

1    its('description') { should eq 'This control checks the description method of the Inspec class' }2    its('description') { should eq 'This control checks the description method of the Control class' }3    its('description') { should eq 'This control checks the description method of the Rule class' }4  describe file('test.txt') do5    its('description') { should eq 'This control checks the description method of the Resource class' }6  describe file('test.txt') do7    its('content') { should eq 'This control checks the description method of the Matcher class' }

description

Using AI Code Generation

1  describe kernel_module('cramfs') do2    it { should_not be_loaded }3  Volume Manager (VxFS) file system. It is recommended that this file system4  describe kernel_module('freevxfs') do5    it { should_not be_loaded }6  describe kernel_module('jffs2') do7    it { should_not be_loaded }8  describe kernel_module('hfs') do9    it { should_not be_loaded }10  describe kernel_module('hfsplus') do11    it { should_not be_loaded }

description

Using AI Code Generation

1    it { should eq 'Inspec Profile' }2    it { should eq 'Inspec Profile' }3    it { should eq 'Inspec Profile' }4    it { should eq 'Inspec Profile' }5    it { should eq 'Inspec Profile' }6    it { should eq 'Inspec Profile' }

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.