chef-cli 1.0.3

data/lib/chef-cli/generator.rb

@@ -0,0 +1,165 @@
+#
+# Copyright:: Copyright (c) 2014-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.
+#
+
+module ChefCLI
+
+  module Generator
+
+    # This is here to hold attr_accessor data for Generator context variables
+    class Context
+      def self.add_attr(name)
+        @attributes ||= [ ]
+
+        if !@attributes.include?(name)
+          @attributes << name
+          attr_accessor(name)
+        end
+      end
+
+      def self.reset
+        return if @attributes.nil?
+
+        @attributes.each do |attr|
+          remove_method(attr)
+        end
+
+        @attributes = nil
+      end
+    end
+
+    def self.reset
+      @context = nil
+    end
+
+    def self.context
+      @context ||= Context.new
+    end
+
+    def self.add_attr_to_context(name, value = nil)
+      sym_name = name.to_sym
+      ChefCLI::Generator::Context.add_attr(sym_name)
+      ChefCLI::Generator::TemplateHelper.delegate_to_app_context(sym_name)
+      context.public_send("#{sym_name}=", value)
+    end
+
+    module TemplateHelper
+
+      def self.delegate_to_app_context(name)
+        define_method(name) do
+          ChefCLI::Generator.context.public_send(name)
+        end
+      end
+
+      def year
+        Time.now.year
+      end
+
+      # Prints the short description of the license, suitable for use in a
+      # preamble to a file. Optionally specify a comment to prepend to each line.
+      def license_description(comment = nil)
+        case license
+        when "all_rights", "none"
+          result = "Copyright:: #{year}, #{copyright_holder}, All Rights Reserved."
+        when "apachev2"
+          result = <<~EOH
+            Copyright:: #{year}, #{copyright_holder}
+
+            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.
+          EOH
+        when "mit"
+          result = <<~EOH
+            The MIT License (MIT)
+
+            Copyright:: #{year}, #{copyright_holder}
+
+            Permission is hereby granted, free of charge, to any person obtaining a copy
+            of this software and associated documentation files (the "Software"), to deal
+            in the Software without restriction, including without limitation the rights
+            to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+            copies of the Software, and to permit persons to whom the Software is
+            furnished to do so, subject to the following conditions:
+
+            The above copyright notice and this permission notice shall be included in
+            all copies or substantial portions of the Software.
+
+            THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+            IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+            FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+            AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+            LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+            OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+            THE SOFTWARE.
+          EOH
+        when "gplv2"
+          result = <<~EOH
+            Copyright:: #{year},  #{copyright_holder}
+
+            This program is free software; you can redistribute it and/or modify
+            it under the terms of the GNU General Public License as published by
+            the Free Software Foundation; either version 2 of the License, or
+            (at your option) any later version.
+
+            This program is distributed in the hope that it will be useful,
+            but WITHOUT ANY WARRANTY; without even the implied warranty of
+            MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+            GNU General Public License for more details.
+
+            You should have received a copy of the GNU General Public License along
+            with this program; if not, write to the Free Software Foundation, Inc.,
+            51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+          EOH
+        when "gplv3"
+          result = <<~EOH
+            Copyright:: #{year},  #{copyright_holder}
+
+            This program is free software: you can redistribute it and/or modify
+            it under the terms of the GNU General Public License as published by
+            the Free Software Foundation, either version 3 of the License, or
+            (at your option) any later version.
+
+            This program is distributed in the hope that it will be useful,
+            but WITHOUT ANY WARRANTY; without even the implied warranty of
+            MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+            GNU General Public License for more details.
+
+            You should have received a copy of the GNU General Public License
+            along with this program.  If not, see <http://www.gnu.org/licenses/>.
+          EOH
+        else
+          raise ArgumentError, "Invalid generator.license setting: #{license}.  See available licenses at https://docs.chef.io/ctl_chef.html#chef-generate-cookbook"
+        end
+        if comment
+          # Ensure there's no trailing whitespace
+          result.gsub(/^(.+)$/, "#{comment} \\1").gsub(/^$/, "#{comment}").strip
+        else
+          result
+        end
+      end
+    end
+
+  end
+end

data/lib/chef-cli/helpers.rb

@@ -0,0 +1,170 @@
+#
+# Copyright:: Copyright (c) 2014-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 "mixlib/shellout" unless defined?(Mixlib::ShellOut)
+require_relative "exceptions"
+
+module ChefCLI
+  module Helpers
+    extend self
+
+    #
+    # Runs given commands using mixlib-shellout
+    #
+    def system_command(*command_args)
+      cmd = Mixlib::ShellOut.new(*command_args)
+      cmd.run_command
+      cmd
+    end
+
+    def err(message)
+      stderr.print("#{message}\n")
+    end
+
+    def msg(message)
+      stdout.print("#{message}\n")
+    end
+
+    def stdout
+      $stdout
+    end
+
+    def stderr
+      $stderr
+    end
+
+    #
+    # Locates the omnibus directories
+    #
+    def omnibus_install?
+      # We also checck if the location we're running from (omnibus_root is relative to currently-running ruby)
+      # includes the version manifest that omnibus packages ship with.  If it doesn't then we're running locally or
+      # out of a gem - so not as an 'omnibus install'
+      File.exist?(expected_omnibus_root) && File.exist?(File.join(expected_omnibus_root, "version-manifest.json"))
+    end
+
+    def omnibus_root
+      @omnibus_root ||= omnibus_expand_path(expected_omnibus_root)
+    end
+
+    def omnibus_bin_dir
+      @omnibus_bin_dir ||= omnibus_expand_path(omnibus_root, "bin")
+    end
+
+    def omnibus_embedded_bin_dir
+      @omnibus_embedded_bin_dir ||= omnibus_expand_path(omnibus_root, "embedded", "bin")
+    end
+
+    def package_home
+      @package_home ||= begin
+                         package_home_set = !([nil, ""].include? ENV["CHEF_WORKSTATION_HOME"])
+                         if package_home_set
+                           ENV["CHEF_WORKSTATION_HOME"]
+                         else
+                           default_package_home
+                         end
+                       end
+    end
+
+    # Returns the directory that contains our main symlinks.
+    # On Mac we place all of our symlinks under /usr/local/bin on other
+    # platforms they are under /usr/bin
+    def usr_bin_prefix
+      @usr_bin_prefix ||= os_x? ? "/usr/local/bin" : "/usr/bin"
+    end
+
+    # Returns the full path to the given command under usr_bin_prefix
+    def usr_bin_path(command)
+      File.join(usr_bin_prefix, command)
+    end
+
+    # Unix users do not want git on their path if they already have it installed.
+    # Because we put `embedded/bin` on the path we must move the git binaries
+    # somewhere else that we can append to the end of the path.
+    # This is only a temporary solution - see https://github.com/chef/chef-cli/issues/854
+    # for a better proposed solution.
+    def git_bin_dir
+      @git_bin_dir ||= File.expand_path(File.join(omnibus_root, "gitbin"))
+    end
+
+    # In our Windows ChefCLI omnibus package we include Git For Windows, which
+    # has a bunch of helpful unix utilties (like ssh, scp, etc.) bundled with it
+    def git_windows_bin_dir
+      @git_windows_bin_dir ||= File.expand_path(File.join(omnibus_root, "embedded", "git", "usr", "bin"))
+    end
+
+    #
+    # environment vars for omnibus
+    #
+    def omnibus_env
+      @omnibus_env ||=
+        begin
+          user_bin_dir = File.expand_path(File.join(Gem.user_dir, "bin"))
+          path = [ omnibus_bin_dir, user_bin_dir, omnibus_embedded_bin_dir, ENV["PATH"] ]
+          path << git_bin_dir if Dir.exist?(git_bin_dir)
+          path << git_windows_bin_dir if Dir.exist?(git_windows_bin_dir)
+          {
+            "PATH" => path.join(File::PATH_SEPARATOR),
+            "GEM_ROOT" => Gem.default_dir,
+            "GEM_HOME" => Gem.user_dir,
+            "GEM_PATH" => Gem.path.join(File::PATH_SEPARATOR),
+          }
+        end
+    end
+
+    private
+
+    def omnibus_expand_path(*paths)
+      dir = File.expand_path(File.join(paths))
+      raise OmnibusInstallNotFound.new() unless dir && File.directory?(dir)
+      dir
+    end
+
+    def expected_omnibus_root
+      File.expand_path(File.join(Gem.ruby, "..", "..", ".."))
+    end
+
+    def default_package_home
+      if Chef::Platform.windows?
+        File.join(ENV["LOCALAPPDATA"], "chef-workstation")
+      else
+        File.expand_path("~/.chef-workstation")
+      end
+    end
+
+    # Open a file. By default, the mode is for read+write,
+    # and binary so that windows writes out what we tell it,
+    # as this is the most common case we have.
+    def with_file(path, mode = "wb+", &block)
+      File.open(path, mode, &block)
+    end
+
+    # @api private
+    # This method resets all the instance variables used. It
+    # should only be used for testing
+    def reset!
+      instance_variables.each do |ivar|
+        instance_variable_set(ivar, nil)
+      end
+    end
+
+    # Returns true if we are on Mac OS X. Otherwise false
+    def os_x?
+      !!(RUBY_PLATFORM =~ /darwin/)
+    end
+  end
+end

data/lib/chef-cli/pager.rb

@@ -0,0 +1,104 @@
+#
+# Copyright:: Copyright (c) 2015-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_relative "ui"
+
+module ChefCLI
+  class Pager
+
+    attr_reader :pager_pid
+
+    def initialize(enable_pager: true)
+      @enable_pager = enable_pager
+      @pipe = nil
+    end
+
+    def pager_enabled?
+      !!(@enable_pager && have_tty? && env["PAGER"])
+    end
+
+    def ui
+      @ui ||=
+        if pager_enabled?
+          UI.new(out: parent_stdout)
+        else
+          UI.new
+        end
+    end
+
+    def with_pager
+      start
+      begin
+        yield self
+      ensure
+        wait
+      end
+    end
+
+    def start
+      return false unless pager_enabled?
+
+      # Ignore CTRL-C because it can cause the parent to die before the
+      # pager which causes wonky behavior in the terminal
+      Kernel.trap(:INT, "IGNORE")
+
+      @pager_pid = Process.spawn(pager_env, env["PAGER"], in: child_stdin)
+
+      child_stdin.close
+    end
+
+    def wait
+      return false unless pager_enabled?
+
+      # Sends EOF to the PAGER
+      parent_stdout.close
+      # wait or else we'd kill the pager when we exit
+      Process.waitpid(pager_pid)
+    end
+
+    # @api private
+    # This is just public so we can stub it for testing
+    def env
+      ENV
+    end
+
+    # @api private
+    # This is just public so we can stub it for testing
+    def have_tty?
+      $stdout.tty?
+    end
+
+    private
+
+    def child_stdin
+      pipe[0]
+    end
+
+    def parent_stdout
+      pipe[1]
+    end
+
+    def pipe
+      @pipe ||= IO.pipe
+    end
+
+    def pager_env
+      { "LESS" => "-FRX", "LV" => "-c" }
+    end
+
+  end
+end

data/lib/chef-cli/policyfile/artifactory_cookbook_source.rb

@@ -0,0 +1,102 @@
+#
+# 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 "json"
+require_relative "../cookbook_omnifetch"
+require_relative "source_uri"
+require_relative "../exceptions"
+require "chef/http/simple"
+
+module ChefCLI
+  module Policyfile
+    class ArtifactoryCookbookSource
+
+      attr_reader :uri
+      attr_reader :preferred_cookbooks
+      attr_reader :chef_config
+
+      def initialize(uri, chef_config: nil)
+        @uri = uri
+        @http_connections = {}
+        @chef_config = chef_config
+        @preferred_cookbooks = []
+        yield self if block_given?
+      end
+
+      def default_source_args
+        [:artifactory, uri]
+      end
+
+      def ==(other)
+        other.kind_of?(self.class) && other.uri == uri && other.preferred_cookbooks == preferred_cookbooks
+      end
+
+      def preferred_for(*cookbook_names)
+        preferred_cookbooks.concat(cookbook_names)
+      end
+
+      def preferred_source_for?(cookbook_name)
+        preferred_cookbooks.include?(cookbook_name)
+      end
+
+      def universe_graph
+        @universe_graph ||= begin
+          full_community_graph.inject({}) do |normalized_graph, (cookbook_name, metadata_by_version)|
+            normalized_graph[cookbook_name] = metadata_by_version.inject({}) do |deps_by_version, (version, metadata)|
+              deps_by_version[version] = metadata["dependencies"]
+              deps_by_version
+            end
+            normalized_graph
+          end
+        end
+      end
+
+      def source_options_for(cookbook_name, cookbook_version)
+        base_uri = full_community_graph[cookbook_name][cookbook_version]["download_url"]
+        {
+          artifactory: base_uri,
+          version: cookbook_version,
+          http_client: http_connection_for(base_uri.to_s),
+        }
+      end
+
+      def null?
+        false
+      end
+
+      def desc
+        "artifactory(#{uri})"
+      end
+
+      private
+
+      def http_connection_for(base_url)
+        headers = { "X-Jfrog-Art-API" => chef_config.artifactory_api_key || ENV["ARTIFACTORY_API_KEY"] }
+        @http_connections[base_url] ||= Chef::HTTP::Simple.new(base_url, headers: headers)
+      end
+
+      def full_community_graph
+        @full_community_graph ||=
+          begin
+            graph_json = http_connection_for(uri).get("/universe")
+            JSON.parse(graph_json)
+          end
+      end
+
+    end
+  end
+end