Class: Chef::Knife::CookbookTest

Inherits:
Chef::Knife show all
Defined in:
lib/chef/knife/cookbook_test.rb

Constant Summary

Constants inherited from Chef::Knife

OFFICIAL_PLUGINS

Instance Attribute Summary

Attributes inherited from Chef::Knife

#name_args, #ui

Instance Method Summary collapse

Methods inherited from Chef::Knife

#api_key, #apply_computed_config, category, chef_config_dir, #cli_keys, common_name, #config_file_settings, config_loader, #configure_chef, #create_object, #delete_object, dependency_loaders, deps, #format_rest_error, guess_category, #humanize_exception, #humanize_http_exception, inherited, #initialize, list_commands, load_commands, load_config, load_deps, #maybe_setup_fips, #merge_configs, msg, #noauth_rest, #parse_options, reset_config_loader!, reset_subcommands!, #rest, run, #run_with_pretty_exceptions, #server_url, #show_usage, snake_case_name, subcommand_category, subcommand_class_from, subcommand_files, subcommand_loader, subcommands, subcommands_by_category, #test_mandatory_field, ui, unnamed?, use_separate_defaults?, #username

Methods included from Mixin::ConvertToClassName

#constantize, #convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #normalize_snake_case_name, #snake_case_basename

Methods included from Mixin::PathSanity

#enforce_path_sanity, #sanitized_path

Constructor Details

This class inherits a constructor from Chef::Knife

Instance Method Details

#cookbook_loaderObject


89
90
91
# File 'lib/chef/knife/cookbook_test.rb', line 89

def cookbook_loader
  @cookbook_loader ||= Chef::CookbookLoader.new(config[:cookbook_path])
end

#runObject


45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# File 'lib/chef/knife/cookbook_test.rb', line 45

def run
  ui.warn("DEPRECATED: Please use ChefSpec or Rubocop to syntax-check cookbooks.")
  config[:cookbook_path] ||= Chef::Config[:cookbook_path]

  checked_a_cookbook = false
  if config[:all]
    cl = cookbook_loader
    cl.load_cookbooks
    cl.each do |key, cookbook|
      checked_a_cookbook = true
      test_cookbook(key)
    end
  else
    @name_args.each do |cb|
      ui.info "checking #{cb}"
      next unless cookbook_loader.cookbook_exists?(cb)
      checked_a_cookbook = true
      test_cookbook(cb)
    end
  end
  unless checked_a_cookbook
    ui.warn("No cookbooks to test in #{Array(config[:cookbook_path]).join(',')} - is your cookbook path misconfigured?")
  end
end

#test_cookbook(cookbook) ⇒ Object


70
71
72
73
74
75
76
77
# File 'lib/chef/knife/cookbook_test.rb', line 70

def test_cookbook(cookbook)
  ui.info("Running syntax check on #{cookbook}")
  Array(config[:cookbook_path]).reverse_each do |path|
    syntax_checker = Chef::Cookbook::SyntaxCheck.for_cookbook(cookbook, path)
    test_ruby(syntax_checker)
    test_templates(syntax_checker)
  end
end

#test_ruby(syntax_checker) ⇒ Object


79
80
81
82
# File 'lib/chef/knife/cookbook_test.rb', line 79

def test_ruby(syntax_checker)
  ui.info("Validating ruby files")
  exit(1) unless syntax_checker.validate_ruby_files
end

#test_templates(syntax_checker) ⇒ Object


84
85
86
87
# File 'lib/chef/knife/cookbook_test.rb', line 84

def test_templates(syntax_checker)
  ui.info("Validating templates")
  exit(1) unless syntax_checker.validate_templates
end