chef-core 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1ad8d39463ec12c89e093da78fe4790cde28660b8014d1eaec546fcfcafb5887
+  data.tar.gz: 9083aa64d6567451495a598934335520b3c4b881e6c6980f74565297e702f1ad
+SHA512:
+  metadata.gz: 1d0e60b3f59e175a4abf57e1738d2c515eb002d5ff01b62f912fe672177e3e1974fe6603a3648c36f0578a449b8d3267f36cfb024c9ee8150ae895c3666eb390
+  data.tar.gz: a3abe193b54e8b06827ecd009cee4609f20af27652f0952af3fdf5b99192d9f3403f124704e7e3d8b9543136748f9e19e87cbc2c4dec6a576634532c1719b484

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+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.

data/i18n/errors/en.yml

@@ -0,0 +1,394 @@
+#
+# 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.
+
+#
+# Error definitions, usage Text.e.ERR999
+#
+# General format:
+# ERRORID
+#   options: a stringified hash containing a optional hash of display options. See display_defaults below.
+#   text: |
+#      text of the message
+#
+# First Line: brief description of the error
+# Second line: blank
+# Third+ : detailed description, max 76 characters per line
+
+# Pluralizing Messages
+# If the text of an error differs based on quantity of subject,
+# you can specify different messages as follows:
+# ERRORID
+#   text: !!pl
+#     0: You have no things.
+#     1: You have one thing.
+#     n: You have lots of things.
+# Text.ERRORID(quanity, [other formatting params])
+
+errors:
+
+  # These are the default display attributes for all messages.
+  # If you want to override them in your gem or application,
+  # include 'errors' -> 'display_defaults' in your gem's i18n/errors/*.yml
+  # and enable it iwth Text.add_localization(path_to_yml)
+  # The most recent gem to add its own error translations will take precedence.
+  #
+  # If you want to override them for specific errors in your error yml,
+  # you can do so as follows:
+  # EXAMPLERROR001:
+  #   options: { decorations: false }
+  #   text: |
+  #     Here is the message text.
+  display_defaults:
+    # Set 'decorations: false' in a message to show only text. Equivalent
+    # to setting all of the other attributes to false individually
+    # stack: show reference to stack trace location in footer
+    # log: show reference to log file location in footer
+    # header: Show error header (currently bolded error id)
+    # footer: show standard footer
+    #
+    # This (end error 'options') are kept as YML strings that are parsed when
+    # the error is to be rendered.
+    # Using a string type is necessary bedcause we don't have access to the
+    # underlying tree structure via R18n.
+    "{ decorations: true, stack: false, log: false, header: true, footer: true }"
+
+
+  # Error headers and footers that are included with error messages will default to the
+  # text below. You can override this in your gem's localization, but make sure
+  # that you don't add additional argument placeholders (eg %3 if the original message
+  # only has %1 and %2) - they won't be populated since chef_core doesn't know about them.
+  footer:
+    both: |
+      If you are not able to resolve this issue, please contact Chef support
+      at workstation@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 workstation@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 workstation@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 workstation@chef.io
+
+  #
+  # Below are the error text definitions for errors that chef_core will raise.
+  #
+
+  # Remote execution and file operation errors are prefixed CHEFRMT
+  CHEFRMT001:
+    text: |
+      The command '%1' exited with return code '%2' on '%3'.
+
+      The following error was reported:
+
+      %4
+
+  # Train-related errors (connectivity, 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.
+  #
+  # TODO: Note that due to a temporary oddity in the split of chef-apply
+  # reusable components into the chef_core gems, chef_core itself
+  # has the definitions for CHEFTRN003+ - that's where the associated
+  # exceptions get thrown.
+  CHEFTRN001:
+    text: |
+      An error has occurred on the %1 connection to %2:
+
+      %2.
+
+  CHEFTRN002:
+    text: |
+      An remote error has occurred:
+
+        %1.
+  # Train-related errors (connectivity, auth failure, etc)
+  # are prefixed CHEFTRN. Note that due to the gem split,
+  # some renumbering would make sense - CHEFTRN001 and 2
+  # now live in chef_core-actions
+  CHEFTRN003:
+    text: |
+      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:
+    text: |
+      Incorrect sudo password provided.
+
+      Please ensure that the password you provided with "--sudo-password" is correct.
+
+  CHEFTRN005:
+    text: |
+      sudo command '%1' not found.
+
+      Please verify that the --sudo-command '%1' is valid
+      and installed on this node.
+
+  CHEFTRN006:
+    text: |
+      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:
+    text: |
+      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:
+    text: |
+      Connection failed: %1
+
+      The following error occured while attempting to connect and authenticate to the target.
+
+      %1
+
+
+  # General errors/unknown errors are handled with CHEFINT
+  CHEFINT001:
+    options: "{ log: true, stack: true }"
+    text: |
+      An unexpected error has occurred:
+
+        %1
+
+  # Internal API errors - give them some formatting
+  CHEFAPI001:
+    options: "{ log: true, stack: true }"
+    text: |
+      API error: provide either :recipe_spec or :resouce_name, :resource_type,
+      and :resource_properties
+
+      You provided: %1
+
+
+  # Maps to: NameError
+  CHEFNET001:
+    text: |
+      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:
+    options: "{ log: true, stack: true }"
+    text: |
+      Uploading config to target failed.
+
+  CHEFUPL004:
+    options: "{ log: true, stack: true }"
+    text: |
+      Uploading handler to target failed.
+
+  CHEFUPL005:
+    options: "{ log: true, stack: true }"
+    text: |
+      Uploading policy bundle to target failed.
+
+  # Maps to: SSL::SSLError with message text indicating verification failure
+  CHEFNET002:
+    text: |
+      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
+
+  # Catch-all error when marshalling mulitple parallel failures.
+  CHEFMULTI001:
+    text: |
+      One or more actions has failed.
+
+      A complete list of failures and possible resolutions can
+      be found in the file below:
+
+        %
+
+  # Errors relating to target host state:
+  CHEFTARG001:
+    text: |
+      '%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.
+
+  # Errors specifying ranges for host names.
+  CHEFRANGE001: |
+    text: |
+      The target '%1' contains an invalid range.
+
+      The range '%2' mixes alphabetic and numeric values.
+      A range must be one or the other.
+
+  CHEFRANGE002:
+    text: |
+      The target '%1' contains too many ranges.
+
+      A single target name can contain up two ranges.
+
+  CHEFRANGE003:
+    text: !!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.
+
+  CHEFVAL011:
+    display: " { decorations: false } "
+    text: |
+      The protocol '%1' is not supported.
+
+      Currently supported remote access protocols are:
+
+        %2
+
+  # Installer action errors
+  CHEFINS002:
+    text: |
+      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:
+    text: |
+      The target has an older version of Chef client installed.
+
+      The target has version %1 installed, but this command
+      requires a minimum version of %2.
+
+      Please upgrade the Chef client on this node to version %2 or later.
+
+  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.
+
+
+  # Remote chef client run failure start here.
+  CHEFCCR001:
+    text: |
+      Could not determine reason for converge failure.
+
+      An error occurred while converging the remote host.
+      I was unable to retrieve the log file which would allow
+      me to provide more information.  Here's where I looked:
+
+        %1
+
+  CHEFCCR002:
+    text: |
+      The converge of the remote host failed for the
+      following reason:
+
+        %1
+
+  CHEFCCR003:
+    text: |
+      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:
+    text: |
+      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:
+    text: |
+      '%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:
+    text: |
+      '%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:
+    text: |
+      The converge of the remote host failed.
+
+      Please examine the log file for a detailed cause of failure.
+

data/lib/chef_core/cliux/status_reporter.rb

@@ -0,0 +1,43 @@
+#
+# 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.
+#
+
+module ChefCore
+  module CLIUX
+    class StatusReporter
+
+      def initialize(ui_element, prefix: nil, key: nil)
+        @ui_element = ui_element
+        @key = key
+        @ui_element.update(prefix: prefix)
+      end
+
+      def update(msg)
+        @ui_element.update({ @key => msg })
+      end
+
+      def success(msg)
+        update(msg)
+        @ui_element.success
+      end
+
+      def error(msg)
+        update(msg)
+        @ui_element.error
+      end
+    end
+  end
+end