chef-apply 0.1.2 → 0.1.15

data/i18n/errors/en.yml

@@ -0,0 +1,341 @@
+# Error definitions, usage Text.e.ERR999
+# General format:
+# First Line: brief description of the error
+# Second line: blank
+# Third+ : detailed description, max 76 characters per line
+errors:
+  rendering_defaults: {header: true, footer: true, stack: true, log: true}
+  # Catch-all for the worst case
+  UNKNOWN: An unknown error has occurred.
+
+  # Installer action errors
+  CHEFINS002:
+      The target does not have chef-client installed.
+
+      This command is powered by the Chef client.  In order to make use of it
+      on this node, the Chef client must be installed first.
+
+      Re-running this command without the '--no-install' flag will
+      automatically perform the installation.
+
+  CHEFINS003: |
+    The target's installed version of Chef Client is too old.
+
+    Version %1 is installed, but this command requires a
+    minimum version of %2 (Chef 13) or %3 (Chef 14).
+
+  CHEFINS004: |
+    The target's installed version of Chef Client is too old.
+
+    Version %1 is installed, but this command requires a
+    minimum version of %2.
+
+  # Local errors trying to create policy to send to target
+  CHEFPOLICY001: |
+    Could not create local Policyfile bundle.
+
+    The following error was reported:
+
+      %1
+
+  # Remote execution and file operation errors are prefixed CHEFRMT
+  CHEFRMT001: |
+    The command '%1' exited with return code '%2' on '%3'.
+
+    The following error was reported:
+
+      %4
+
+  # Remote chef client run failure start here.
+  CHEFCCR001: |
+    Could not determine reason for converge failure.
+
+    STDOUT (may be blank)
+
+      %1
+
+    STDERR (may be blank)
+
+      %2
+
+    An error occurred while converging the remote host.
+    I was unable to retrieve the log file which would allow
+    me to provide more information.  Above is the output
+    that occurred while trying to retrieve the remote log file.
+
+  CHEFCCR002: |
+    The converge of the remote host failed for the
+    following reason:
+
+      %1
+
+  CHEFCCR003: |
+    The action '%1' is not valid.
+
+    Valid actions are:
+
+      %2
+
+    For more information, please consult the documentation
+    for this resource:
+
+      https://docs.chef.io/resource_reference.html
+
+  CHEFCCR004: |
+    A property value you provided is not valid:
+
+      %1
+
+    Please consult the documentation for properties
+    supported by your resource and their valid values:
+
+      https://docs.chef.io/resource_reference.html
+
+  CHEFCCR005: |
+    '%1' is not a valid Chef resource.
+
+    Please consult the documentation for a list of valid resources:
+
+      https://docs.chef.io/resource_reference.html
+
+  CHEFCCR006: |
+    '%1' is not a property of '%2'.
+
+    Please consult the documentation for %2 for a list of
+    valid properties:
+
+      https://docs.chef.io/resource_reference.html
+
+  CHEFCCR099: |
+    The converge of the remote host failed.
+
+    Please examine the log file for a detailed cause of failure.
+
+  # Train-related errors (connectivy, auth failure, etc)
+  # are prefixed CHEFTRN. Non-specific descendants of Train::Error
+  # will resolve to CHEFTRN001, and we can add additional
+  # more specific text as we need it.
+  CHEFTRN001: |
+    An error has occurred on the %1 connection to %2:
+
+    %2.
+
+  CHEFTRN002: |
+    An remote error has occurred:
+
+      %1.
+
+  CHEFTRN003: |
+    Password required for sudo.
+
+    This target requires a password to perform sudo operations.  Please provide a
+    password using the --sudo-password option. For example if the sudo password is
+    in the environment variable $CHEF_RUN_SUDO_PASSWORD, you could use:
+
+    --sudo-password $CHEF_RUN_SUDO_PASSWORD
+
+  CHEFTRN004: |
+    Incorrect sudo password provided.
+
+    Please ensure that the password you provided with "--sudo-password" is correct.
+
+  CHEFTRN005: |
+    sudo command '%1' not found.
+
+    Please verify that the --sudo-command '%1' is valid
+    and installed on this node.
+
+  CHEFTRN006: |
+    sudo requires tty on this system
+
+    In order to continue, sudo must be configured to no longer require tty.
+    You can do this by modifying /etc/sudoers:
+
+    For all users:
+      Defaults !requiretty
+
+    Per-user:
+      Defaults:username !requiretty
+
+  CHEFTRN007: |
+    No authentication methods available.
+
+    Try...
+    - Provide a password with "--password PASSWORD"
+    - Provide a key with "-identity-file PATH/TO/FILE"
+    - Enable ssh-agent and add keys
+    - Add a host entry to your ssh configuration
+
+    Additional instructions can be found in the troubleshooting documentation:
+
+    https://www.chef.sh/docs/chef-workstation/troubleshooting/#error-code-cheftrn007
+
+  CHEFTRN999: |
+    Connection failed: %1
+
+    The following error occured while attempting to connect and authenticate to the target.
+
+    %1
+
+  # CLI argument validation errors
+  CHEFVAL002: |
+    You must supply <TARGET[S]> and either <RESOURCE> and <RESOURCE_NAME> or <RECIPE>
+
+  CHEFVAL003: |
+    Property '%1' did not match the 'key=value' syntax required
+
+  CHEFVAL004: |
+    Please provide a recipe in the form 'path/to/recipe/file.rb',
+    'path/to/cookbook', 'cookbook_name' or 'cookbook_name::recipe_name'.
+
+    You provided '%1'.
+
+  CHEFVAL005: |
+    The cookbook provided could not be loaded. Ensure it contains a valid
+    'metadata.rb'.
+
+    Cookbook path is '%1'.
+
+  CHEFVAL006: |
+    Cookbook '%1' could not be found in any of the following directories
+
+    %2
+
+  CHEFVAL007: |
+    There is no default recipe in cookbook '%2'. Please provide the name of the recipe to run, for example:
+      %2::some_recipe
+
+    Cookbook path is '%1'.
+
+  CHEFVAL008: |
+    There is no recipe named '%2' in the cookbook '%4', which I found at '%1'.
+
+    Please include the name of the recipe you wish to converge on the remote target.
+
+    These are the available recipes in '%4':
+    %3
+
+  CHEFVAL009: |
+    File extension '%1' is unsupported. Currently recipes must be specified with a `.rb` extension.
+
+  CHEFVAL010: |
+    The flag '%1' does not exist.
+
+      Available flags are:
+    %2
+
+  CHEFVAL011: |
+    The protocol '%1' is not supported.
+
+    Currently supported remote access protocols are:
+
+      %2
+
+  # General errors/unknown errors are handled with CHEFINT
+  CHEFINT001: |
+    An unexpected error has occurred:
+
+      %1
+
+  # Internal API errors - give them some formatting
+  CHEFAPI001: |
+    API error: provide either :recipe_spec or :resouce_name, :resource_type,
+    and :resource_properties
+
+    You provided: %1
+
+
+  # Maps to: NameError
+  CHEFNET001: |
+    A network error occurred:
+
+      %1
+
+    Please verify the host name or address is correct and that the host is
+    reachable before trying again.
+
+  # Remote chef client run failure start here.
+  CHEFUPL003: |
+    Uploading config to target failed.
+
+  CHEFUPL004: |
+    Uploading handler to target failed.
+
+  CHEFUPL005: |
+    Uploading policy bundle to target failed.
+
+  # Maps to: SSL::SSLError with message text indicating verification failure
+  CHEFNET002: |
+    SSL host verification failed.
+
+    I could not verify the identity of the remote host.
+
+    If you are certain that you are connecting to the correct host,
+    you can specify the '--no-ssl-verify' option for this command, or
+    make it the default by setting the following in your configuration:
+
+      [connection.winrm]
+      ssl_verify=false
+
+  # Errors specifying target ranges
+  CHEFRANGE001: |
+    The target '%1' contains an invalid range.
+
+    The range '%2' mixes alphabetic and numeric values.
+    A range must be one or the other.
+
+  CHEFRANGE002:
+    The target '%1' contains too many ranges.
+
+    A single target name can contain up two ranges.
+
+  CHEFRANGE003: !!pl
+    1:
+      The target provided resolves to too many hosts.
+
+      At this time there is a limit of %2 hosts in a single operation.
+    n:
+      The targets provided resolve to too many hosts.
+
+      At this time there is a limit of %2 hosts in a single operation.
+
+  # Errors related to multi-target execution
+  CHEFMULTI001: |
+    One or more actions has failed.
+
+    A complete list of failures and possible resolutions can
+    be found in the file below:
+
+      %1
+
+  # Errors relating to target state:
+  CHEFTARG001: |
+    '%1' is not a supported target operating system at this time.
+
+    We plan to support a range of target operating systems,
+    but during this targeted beta we are constraining our efforts
+    to Windows and Linux.
+
+
+  footer:
+    both: |
+      If you are not able to resolve this issue, please contact Chef support
+      at beta@chef.io and include the log file and stack trace from the
+      locations below:
+
+        %1
+        %2
+
+    log_only:  |
+      If you are not able to resolve this issue, please contact Chef support
+      at beta@chef.io and include the log file from the location below:
+        %1
+
+    stack_only:  |
+      If you are not able to resolve this issue, please contact Chef support
+      at beta@chef.io and include the stack trace from the location below:
+        %1
+
+    neither:  |
+      If you are not able to resolve this issue, please contact Chef support
+      at beta@chef.io

data/lib/chef_apply/action/base.rb

@@ -84,6 +84,10 @@ module ChefApply
       # Chef will try 'downloading' the policy from the internet unless we pass it a valid, local file
       # in the working directory. By pointing it at a local file it will just copy it instead of trying
       # to download it.
+      #
+      # Chef 13 on Linux requires full path specifiers for --config and --recipe-url while on Chef 13 and 14 on
+      # Windows must use relative specifiers to prevent URI from causing an error
+      # (https://github.com/chef/chef/pull/7223/files).
       def run_chef(working_dir, config, policy)
         case family
         when :windows
@@ -96,7 +100,7 @@ module ChefApply
         else
           # cd is shell a builtin, so much call bash. This also means all commands are executed
           # with sudo (as long as we are hardcoding our sudo use)
-          "bash -c 'cd #{working_dir}; chef-client -z --config #{config} --recipe-url #{policy}'"
+          "bash -c 'cd #{working_dir}; chef-client -z --config #{File.join(working_dir, config)} --recipe-url #{File.join(working_dir, policy)}'"
         end
       end
 

data/lib/chef_apply/action/generate_local_policy.rb

@@ -0,0 +1,59 @@
+#
+# Copyright:: Copyright (c) 2017 Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require "chef_apply/action/base"
+require "chef_apply/error"
+module ChefApply::Action
+  class GenerateLocalPolicy < Base
+    attr_reader :archive_file_location
+    def initialize(config)
+      super(config)
+      @cookbook = config.delete :cookbook
+    end
+
+    def perform_action
+      notify(:generating)
+      installer.run
+      notify(:exporting)
+      exporter.run
+      @archive_file_location = exporter.archive_file_location
+      notify(:success)
+    rescue ChefDK::PolicyfileInstallError => e
+      raise PolicyfileInstallError.new(e)
+    end
+
+    def exporter
+      require "chef-dk/policyfile_services/export_repo"
+      @exporter ||=
+        ChefDK::PolicyfileServices::ExportRepo.new(policyfile: @cookbook.policyfile_lock_path,
+                                                   root_dir: @cookbook.path,
+                                                   export_dir: @cookbook.export_path,
+                                                   archive: true, force: true)
+    end
+
+    def installer
+      require "chef-dk/policyfile_services/install"
+      require "chef-dk/ui"
+      @installer ||=
+        ChefDK::PolicyfileServices::Install.new(ui: ChefDK::UI.null(), root_dir: @cookbook.path)
+    end
+
+  end
+  class PolicyfileInstallError < ChefApply::Error
+    def initialize(cause_err); super("CHEFPOLICY001", cause_err.message); end
+  end
+end

data/lib/chef_apply/action/generate_temp_cookbook.rb

@@ -0,0 +1,86 @@
+#
+# Copyright:: Copyright (c) 2018 Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require "chef_apply/action/base"
+require "chef_apply/temp_cookbook"
+require "chef_apply/error"
+
+module ChefApply::Action
+  class GenerateTempCookbook < Base
+    attr_reader :generated_cookbook
+
+    def self.from_options(opts)
+      if opts.has_key?(:recipe_spec)
+        GenerateCookbookFromRecipe.new(opts)
+      elsif opts.has_key?(:resource_name) &&
+          opts.has_key?(:resource_type) &&
+          opts.has_key?(:resource_properties)
+        GenerateCookbookFromResource.new(opts)
+      else
+        raise MissingOptions.new(opts)
+      end
+    end
+
+    def initialize(options)
+      super(options)
+      @generated_cookbook ||= ChefApply::TempCookbook.new
+    end
+
+    def perform_action
+      notify(:generating)
+      generate
+      notify(:success)
+    end
+
+    def generate
+      raise NotImplemented
+    end
+  end
+
+  class GenerateCookbookFromRecipe < GenerateTempCookbook
+    def generate
+      recipe_specifier = config.delete :recipe_spec
+      repo_paths = config.delete :cookbook_repo_paths
+      ChefApply::Log.debug("Beginning to look for recipe specified as #{recipe_specifier}")
+      if File.file?(recipe_specifier)
+        ChefApply::Log.debug("#{recipe_specifier} is a valid path to a recipe")
+        recipe_path = recipe_specifier
+      else
+        require "chef_apply/recipe_lookup"
+        rl = ChefApply::RecipeLookup.new(repo_paths)
+        cookbook_path_or_name, optional_recipe_name = rl.split(recipe_specifier)
+        cookbook = rl.load_cookbook(cookbook_path_or_name)
+        recipe_path = rl.find_recipe(cookbook, optional_recipe_name)
+      end
+      generated_cookbook.from_existing_recipe(recipe_path)
+    end
+  end
+
+  class GenerateCookbookFromResource < GenerateTempCookbook
+    def generate
+      type = config.delete :resource_type
+      name = config.delete :resource_name
+      props = config.delete :resource_properties
+      ChefApply::Log.debug("Generating cookbook for ad-hoc resource #{type}[#{name}]")
+      generated_cookbook.from_resource(type, name, props)
+    end
+  end
+
+  class MissingOptions < ChefApply::APIError
+    def initialize(*args); super("CHEFAPI001", *args); end
+  end
+end