chef-utils 16.10.17 → 17.10.19

data/lib/chef-utils/dist.rb

@@ -1,98 +1,151 @@
-# frozen_string_literal: true
-module ChefUtils
-  # This class is not fully implemented, depending on it is not recommended!
-  module Dist
-    class Apply
-      # The chef-apply product name
-      PRODUCT = "Chef Infra Apply"
-
-      # The chef-apply binary
-      EXEC = "chef-apply"
-    end
-
-    class Automate
-      # name of the automate product
-      PRODUCT = "Chef Automate"
-    end
-
-    class Infra
-      # When referencing a product directly, like Chef (Now Chef Infra)
-      PRODUCT = "Chef Infra Client"
-
-      # A short designation for the product, used in Windows event logs
-      # and some nomenclature.
-      SHORT = "chef"
-
-      # The client's alias (chef-client)
-      CLIENT = "chef-client"
-
-      # The chef executable, as in `chef gem install` or `chef generate cookbook`
-      EXEC = "chef"
-
-      # The chef-shell executable
-      SHELL = "chef-shell"
-
-      # Configuration related constants
-      # The chef-shell configuration file
-      SHELL_CONF = "chef_shell.rb"
-
-      # The user's configuration directory
-      USER_CONF_DIR = ".chef"
-
-      # The suffix for Chef's /etc/chef, /var/chef and C:\\Chef directories
-      # "chef" => /etc/cinc, /var/cinc, C:\\cinc
-      DIR_SUFFIX = "chef"
-    end
-
-    class Org
-      # product Website address
-      WEBSITE = "https://chef.io"
-
-      # The downloads site
-      DOWNLOADS_URL = "downloads.chef.io"
-
-      # The legacy conf folder: C:/opscode/chef. Specifically the "opscode" part
-      # DIR_SUFFIX is appended to it in code where relevant
-      LEGACY_CONF_DIR = "opscode"
-
-      # Enable forcing Chef EULA
-      ENFORCE_LICENSE = true
-
-      # product patents page
-      PATENTS = "https://www.chef.io/patents"
-
-      # knife documentation page
-      KNIFE_DOCS = "https://docs.chef.io/workstation/knife/"
-    end
-
-    class Server
-      # The name of the server product
-      PRODUCT = "Chef Infra Server"
-
-      # The server's configuration directory
-      CONF_DIR = "/etc/chef-server"
-
-      # The servers's alias (chef-server)
-      SERVER = "chef-server"
-
-      # The server's configuration utility
-      SERVER_CTL = "chef-server-ctl"
-    end
-
-    class Solo
-      # Chef-Solo's product name
-      PRODUCT = "Chef Infra Solo"
-
-      # The chef-solo executable (legacy local mode)
-      EXEC = "chef-solo"
-    end
-
-    class Zero
-      # chef-zero executable
-      PRODUCT = "Chef Infra Zero"
-
-      # The chef-zero executable (local mode)
-      EXEC = "chef-zero"
-    end
-  end
-end
+# frozen_string_literal: true
+module ChefUtils
+  # This class is not fully implemented, depending on it is not recommended!
+  module Dist
+    class Apply
+      # The chef-apply product name
+      PRODUCT = "Chef Infra Apply"
+
+      # The chef-apply binary
+      EXEC = "chef-apply"
+    end
+
+    class Automate
+      # name of the automate product
+      PRODUCT = "Chef Automate"
+    end
+
+    class Cli
+      # the chef-cli product name
+      PRODUCT = "Chef CLI"
+
+      # the chef-cli gem
+      GEM = "chef-cli"
+    end
+
+    class Habitat
+      # name of the Habitat product
+      PRODUCT = "Chef Habitat"
+
+      # A short designation for the product
+      SHORT = "habitat"
+
+      # The hab cli binary
+      EXEC = "hab"
+    end
+
+    class Infra
+      # When referencing a product directly, like Chef (Now Chef Infra)
+      PRODUCT = "Chef Infra Client"
+
+      # A short designation for the product, used in Windows event logs
+      # and some nomenclature.
+      SHORT = "chef"
+
+      # The client's alias (chef-client)
+      CLIENT = "chef-client"
+
+      # The chef executable, as in `chef gem install` or `chef generate cookbook`
+      EXEC = "chef"
+
+      # The chef-shell executable
+      SHELL = "chef-shell"
+
+      # Configuration related constants
+      # The chef-shell configuration file
+      SHELL_CONF = "chef_shell.rb"
+
+      # The user's configuration directory
+      USER_CONF_DIR = ".chef"
+
+      # The suffix for Chef's /etc/chef, /var/chef and C:\\Chef directories
+      # "chef" => /etc/cinc, /var/cinc, C:\\cinc
+      DIR_SUFFIX = "chef"
+
+      # The client's gem
+      GEM = "chef"
+    end
+
+    class Inspec
+      # The InSpec product name
+      PRODUCT = "Chef InSpec"
+
+      # The inspec binary
+      EXEC = "inspec"
+    end
+
+    class Org
+      # product Website address
+      WEBSITE = "https://chef.io"
+
+      # The downloads site
+      DOWNLOADS_URL = "chef.io/downloads"
+
+      # The legacy conf folder: C:/opscode/chef. Specifically the "opscode" part
+      # DIR_SUFFIX is appended to it in code where relevant
+      LEGACY_CONF_DIR = "opscode"
+
+      # Enable forcing Chef EULA
+      ENFORCE_LICENSE = true
+
+      # product patents page
+      PATENTS = "https://www.chef.io/patents"
+
+      # knife documentation page
+      KNIFE_DOCS = "https://docs.chef.io/workstation/knife/"
+
+      # the name of the overall infra product
+      PRODUCT = "Chef Infra"
+
+      # Omnitruck URL
+      OMNITRUCK_URL = "https://omnitruck.chef.io/install.sh"
+    end
+
+    class Server
+      # The name of the server product
+      PRODUCT = "Chef Infra Server"
+
+      # The server's configuration directory
+      CONF_DIR = "/etc/chef-server"
+
+      # The servers's alias (chef-server)
+      SERVER = "chef-server"
+
+      # The server's configuration utility
+      SERVER_CTL = "chef-server-ctl"
+
+      # OS user for server
+      SYSTEM_USER = "opscode"
+
+      # The server`s docs URL
+      SERVER_DOCS = "https://docs.chef.io/server/"
+    end
+
+    class Solo
+      # Chef-Solo's product name
+      PRODUCT = "Chef Infra Solo"
+
+      # The chef-solo executable (legacy local mode)
+      EXEC = "chef-solo"
+    end
+
+    class Workstation
+      # The full marketing name of the product
+      PRODUCT = "Chef Workstation"
+
+      # The suffix for Chef Workstation's /opt/chef-workstation or C:\\opscode\chef-workstation
+      DIR_SUFFIX = "chef-workstation"
+
+      # Workstation banner/help text
+      DOCS = "https://docs.chef.io/workstation/"
+    end
+
+    class Zero
+      # chef-zero executable
+      PRODUCT = "Chef Infra Zero"
+
+      # The chef-zero executable (local mode)
+      EXEC = "chef-zero"
+    end
+  end
+end

data/lib/chef-utils/dsl/architecture.rb

@@ -1,150 +1,150 @@
-# frozen_string_literal: true
-#
-# Copyright:: Copyright (c) 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 "../internal"
-
-module ChefUtils
-  module DSL
-    module Architecture
-      include Internal
-
-      # Determine if the current architecture is 64-bit.
-      #
-      # @since 15.5
-      #
-      # @return [Boolean]
-      #
-      def _64_bit?(node = __getnode)
-        %w{amd64 x86_64 ppc64 ppc64le s390x ia64 sparc64 aarch64 arch64 arm64 sun4v sun4u}
-          .include?(node["kernel"]["machine"])
-      end
-
-      # Determine if the current architecture is 32-bit.
-      #
-      # @since 15.5
-      #
-      # @return [Boolean]
-      #
-      def _32_bit?(node = __getnode)
-        !_64_bit?(node)
-      end
-
-      # Determine if the current architecture is i386.
-      #
-      # @since 15.5
-      #
-      # @return [Boolean]
-      #
-      def i386?(node = __getnode)
-        _32_bit?(node) && intel?(node)
-      end
-
-      # Determine if the current architecture is Intel.
-      #
-      # @since 15.5
-      #
-      # @return [Boolean]
-      #
-      def intel?(node = __getnode)
-        %w{i86pc i386 x86_64 amd64 i686}.include?(node["kernel"]["machine"])
-      end
-
-      # Determine if the current architecture is SPARC.
-      #
-      # @since 15.5
-      #
-      # @return [Boolean]
-      #
-      def sparc?(node = __getnode)
-        %w{sun4u sun4v}.include?(node["kernel"]["machine"])
-      end
-
-      # Determine if the current architecture is PowerPC 64bit Big Endian.
-      #
-      # @since 15.5
-      #
-      # @return [Boolean]
-      #
-      def ppc64?(node = __getnode)
-        %w{ppc64}.include?(node["kernel"]["machine"])
-      end
-
-      # Determine if the current architecture is PowerPC 64bit Little Endian.
-      #
-      # @since 15.5
-      #
-      # @return [Boolean]
-      #
-      def ppc64le?(node = __getnode)
-        %w{ppc64le}.include?(node["kernel"]["machine"])
-      end
-
-      # Determine if the current architecture is PowerPC.
-      #
-      # @since 15.5
-      #
-      # @return [Boolean]
-      #
-      def powerpc?(node = __getnode)
-        %w{powerpc}.include?(node["kernel"]["machine"])
-      end
-
-      # Determine if the current architecture is arm
-      #
-      # @since 15.10
-      #
-      # @return [Boolean]
-      #
-      def arm?(node = __getnode)
-        %w{armv6l armv7l armhf aarch64 arm64 arch64}.include?(node["kernel"]["machine"])
-      end
-
-      # Determine if the current architecture is 32-bit ARM hard float.
-      #
-      # @since 15.5
-      #
-      # @return [Boolean]
-      #
-      def armhf?(node = __getnode)
-        %w{armv6l armv7l armhf}.include?(node["kernel"]["machine"])
-      end
-
-      # Determine if the current architecture is s390x.
-      #
-      # @since 15.5
-      #
-      # @return [Boolean]
-      #
-      def s390x?(node = __getnode)
-        %w{s390x}.include?(node["kernel"]["machine"])
-      end
-
-      # Determine if the current architecture is s390.
-      #
-      # @since 15.5
-      #
-      # @return [Boolean]
-      #
-      def s390?(node = __getnode)
-        %w{s390}.include?(node["kernel"]["machine"])
-      end
-
-      extend self
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: Copyright (c) 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 "../internal"
+
+module ChefUtils
+  module DSL
+    module Architecture
+      include Internal
+
+      # Determine if the current architecture is 64-bit.
+      #
+      # @since 15.5
+      #
+      # @return [Boolean]
+      #
+      def _64_bit?(node = __getnode)
+        %w{amd64 x86_64 ppc64 ppc64le s390x ia64 sparc64 aarch64 arch64 arm64 sun4v sun4u}
+          .include?(node["kernel"]["machine"])
+      end
+
+      # Determine if the current architecture is 32-bit.
+      #
+      # @since 15.5
+      #
+      # @return [Boolean]
+      #
+      def _32_bit?(node = __getnode)
+        !_64_bit?(node)
+      end
+
+      # Determine if the current architecture is i386.
+      #
+      # @since 15.5
+      #
+      # @return [Boolean]
+      #
+      def i386?(node = __getnode)
+        _32_bit?(node) && intel?(node)
+      end
+
+      # Determine if the current architecture is Intel.
+      #
+      # @since 15.5
+      #
+      # @return [Boolean]
+      #
+      def intel?(node = __getnode)
+        %w{i86pc i386 x86_64 amd64 i686}.include?(node["kernel"]["machine"])
+      end
+
+      # Determine if the current architecture is SPARC.
+      #
+      # @since 15.5
+      #
+      # @return [Boolean]
+      #
+      def sparc?(node = __getnode)
+        %w{sun4u sun4v}.include?(node["kernel"]["machine"])
+      end
+
+      # Determine if the current architecture is PowerPC 64bit Big Endian.
+      #
+      # @since 15.5
+      #
+      # @return [Boolean]
+      #
+      def ppc64?(node = __getnode)
+        %w{ppc64}.include?(node["kernel"]["machine"])
+      end
+
+      # Determine if the current architecture is PowerPC 64bit Little Endian.
+      #
+      # @since 15.5
+      #
+      # @return [Boolean]
+      #
+      def ppc64le?(node = __getnode)
+        %w{ppc64le}.include?(node["kernel"]["machine"])
+      end
+
+      # Determine if the current architecture is PowerPC.
+      #
+      # @since 15.5
+      #
+      # @return [Boolean]
+      #
+      def powerpc?(node = __getnode)
+        %w{powerpc}.include?(node["kernel"]["machine"])
+      end
+
+      # Determine if the current architecture is arm
+      #
+      # @since 15.10
+      #
+      # @return [Boolean]
+      #
+      def arm?(node = __getnode)
+        %w{armv6l armv7l armhf aarch64 arm64 arch64}.include?(node["kernel"]["machine"])
+      end
+
+      # Determine if the current architecture is 32-bit ARM hard float.
+      #
+      # @since 15.5
+      #
+      # @return [Boolean]
+      #
+      def armhf?(node = __getnode)
+        %w{armv6l armv7l armhf}.include?(node["kernel"]["machine"])
+      end
+
+      # Determine if the current architecture is s390x.
+      #
+      # @since 15.5
+      #
+      # @return [Boolean]
+      #
+      def s390x?(node = __getnode)
+        %w{s390x}.include?(node["kernel"]["machine"])
+      end
+
+      # Determine if the current architecture is s390.
+      #
+      # @since 15.5
+      #
+      # @return [Boolean]
+      #
+      def s390?(node = __getnode)
+        %w{s390}.include?(node["kernel"]["machine"])
+      end
+
+      extend self
+    end
+  end
+end