chef-cli 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a13b7fe5a79e96a77dbe15637e0c7049ba7a2b1497c9b51ae1a8512dde66173e
-  data.tar.gz: cfa51c708cf8c115755dc5e243f6ac08b658bb71cb9dd4b015d8738de229ae26
+  metadata.gz: 5f07d3f568a94bf70e402ec732f96521233dafdf566b60bdc0ef9fad586e29af
+  data.tar.gz: 6b060133bceeb79fde35c38a41b7c4b6e4a71520f1f631cf37d4f0942838c0ed
 SHA512:
-  metadata.gz: 974da449a8873d332523b92a0a263f675d80bd8b378317e645f80ea2bc5bdcff5fb476a038e7ce41268e1c88222d2625695aef90bf7311ddf2c7972b001c99f2
-  data.tar.gz: 6a3504dc2d8f14b4a1ad63085fb74661c18e89d78551c0d2fd65efdb392c588277fd9202bbada3c09471290743c1eee389268008b6d132d926a958b035024ffe
+  metadata.gz: c429fdd87a900cd5c9178e44edc2eccf48a517a96aa0dd58de2adf5d1d9cdb0ddac522efeacb5676b9a12284bda262030fe8f5e65909ed40e21b5d3fb23845aa
+  data.tar.gz: db8f7b5d1a073a314489315aa35db2554575bba13e37f1ac28c99f0795eb57233d0ae0beb1989f7aa98d0970ed0826cd96849367b1161ecf144d76fc224e9167

data/lib/chef-cli/command/export.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2014-2019 Chef Software Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -67,6 +67,11 @@ module ChefCLI
         description: "Enable stacktraces and other debug output",
         default:     false
 
+      option :policy_group,
+        long:        "--policy-group POLICY_GROUP",
+        description: "The policy_group to include in the export (default: 'local')",
+        default:     nil
+
       attr_reader :policyfile_relative_path
       attr_reader :export_dir
 
@@ -120,11 +125,14 @@ module ChefCLI
       end
 
       def export_service
-        @export_service ||= PolicyfileServices::ExportRepo.new(policyfile: policyfile_relative_path,
-                                                               export_dir: export_dir,
-                                                               root_dir: Dir.pwd,
-                                                               archive: archive?,
-                                                               force: config[:force])
+        @export_service ||= PolicyfileServices::ExportRepo.new(
+          policyfile: policyfile_relative_path,
+          export_dir: export_dir,
+          root_dir: Dir.pwd,
+          archive: archive?,
+          force: config[:force],
+          policy_group: config[:policy_group]
+        )
       end
 
       def handle_error(error)

data/lib/chef-cli/policyfile_services/export_repo.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2014-2019 Chef Software Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -33,20 +33,15 @@ module ChefCLI
 
     class ExportRepo
 
-      # Policy groups provide namespaces for policies so that a Chef Infra Server can
-      # have multiple active iterations of a policy at once, but we don't need
-      # this when serving a single exported policy via Chef Zero, so hardcode
-      # it to a "well known" value:
-      POLICY_GROUP = "local".freeze
-
       include Policyfile::StorageConfigDelegation
 
       attr_reader :storage_config
       attr_reader :root_dir
       attr_reader :export_dir
       attr_reader :ui
+      attr_reader :policy_group
 
-      def initialize(policyfile: nil, export_dir: nil, root_dir: nil, archive: false, force: false)
+      def initialize(policyfile: nil, export_dir: nil, root_dir: nil, archive: false, force: false, policy_group: nil)
         @root_dir = root_dir
         @export_dir = File.expand_path(export_dir)
         @archive = archive
@@ -55,6 +50,8 @@ module ChefCLI
 
         @policy_data = nil
         @policyfile_lock = nil
+        @policy_group = policy_group
+        @policy_group ||= "local".freeze
 
         policyfile_rel_path = policyfile || "Policyfile.rb"
         policyfile_full_path = File.expand_path(policyfile_rel_path, root_dir)
@@ -243,7 +240,7 @@ module ChefCLI
             #
 
             policy_name '#{policy_name}'
-            policy_group 'local'
+            policy_group '#{policy_group}'
 
             use_policyfile true
             policy_document_native_api true
@@ -301,9 +298,8 @@ module ChefCLI
             ### policy_groups/
 
             Policy groups are used by Chef Infra Server to manage multiple revisions of the same
-            policy. However, exported policies contain only a single policy revision, so
-            this policy group name is hardcoded to "local" and should not be changed.
-
+            policy. The default "local" policy is recommended for export use since there can be
+            no different revisions when not utilizing a server.
           README
         end
       end
@@ -389,7 +385,7 @@ module ChefCLI
       end
 
       def policy_group_repo_item_path
-        File.join(staging_dir, "policy_groups", "local.json")
+        File.join(staging_dir, "policy_groups", "#{policy_group}.json")
       end
 
       def dot_chef_staging_dir

data/lib/chef-cli/version.rb

@@ -16,5 +16,5 @@
 #
 
 module ChefCLI
-  VERSION = "5.1.0".freeze
+  VERSION = "5.2.0".freeze
 end

data/spec/unit/command/export_spec.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2014-2018 Chef Software Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -84,6 +84,10 @@ describe ChefCLI::Command::Export do
         expect(command.export_service.policyfile_filename).to eq(File.expand_path("Policyfile.rb"))
       end
 
+      it "uses the default policy_group name" do
+        expect(command.export_service.policy_group).to eq("local")
+      end
+
     end
 
     context "when a Policyfile relative path and export path are given" do
@@ -98,6 +102,19 @@ describe ChefCLI::Command::Export do
         expect(command.export_service.policyfile_filename).to eq(File.expand_path("CustomNamedPolicy.rb"))
       end
     end
+
+    context "when a policy_group is given" do
+
+      let(:params) { [ "path/to/export", "--policy_group", "production" ] }
+
+      it "configures the export service with the export path" do
+        expect(command.export_service.export_dir).to eq(File.expand_path("path/to/export"))
+      end
+
+      it "configures the export service with the policyfile relative path" do
+        expect(command.export_service.policy_group).to eq("production")
+      end
+    end
   end
 
   describe "running the export" do

data/spec/unit/policyfile_services/export_repo_spec.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2014-2018 Chef Software Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -42,12 +42,15 @@ describe ChefCLI::PolicyfileServices::ExportRepo do
 
   let(:archive) { false }
 
+  let(:policy_group) { nil }
+
   subject(:export_service) do
     described_class.new(policyfile: policyfile_rb_explicit_name,
                         root_dir: working_dir,
                         export_dir: export_dir,
                         archive: archive,
-                        force: force_export)
+                        force: force_export,
+                        policy_group: policy_group)
   end
 
   it "uses Policyfile.rb as the default Policyfile name" do
@@ -306,6 +309,52 @@ describe ChefCLI::PolicyfileServices::ExportRepo do
             expect(File).to exist(readme_path)
           end
 
+          context "when the policy_group is changed" do
+            let(:policy_group) { "production" }
+            it "creates a policy_group file for a specified policy group with the revision id of the exported policy" do
+              exported_policy_group_path = File.join(export_dir, "policy_groups", "production.json")
+              exported_policy_group_data = FFI_Yajl::Parser.parse(IO.read(exported_policy_group_path))
+
+              expected_data = { "policies" => { "install-example" => { "revision_id" => revision_id } } }
+
+              expect(exported_policy_group_data).to eq(expected_data)
+            end
+
+            it "creates a working local mode configuration file with the changed policy_group" do
+              expected_config_text = <<~CONFIG
+              ### Chef Infra Client Configuration ###
+              # The settings in this file will configure chef to apply the exported policy in
+              # this directory. To use it, run:
+              #
+              # chef-client -z
+              #
+
+              policy_name 'install-example'
+              policy_group 'production'
+
+              use_policyfile true
+              policy_document_native_api true
+
+              # In order to use this repo, you need a version of Chef Infra Client and Chef Zero
+              # that supports policyfile "native mode" APIs:
+              current_version = Gem::Version.new(Chef::VERSION)
+              unless Gem::Requirement.new(">= 12.7").satisfied_by?(current_version)
+                puts("!" * 80)
+                puts(<<-MESSAGE)
+              This Chef Repo requires features introduced in Chef Infra Client 12.7, but you are using
+              Chef \#{Chef::VERSION}. Please upgrade to Chef Infra Client 12.7 or later.
+              MESSAGE
+                puts("!" * 80)
+                exit!(1)
+              end
+
+              CONFIG
+              config_path = File.join(export_dir, ".chef", "config.rb")
+              expect(File).to exist(config_path)
+              expect(IO.read(config_path)).to eq(expected_config_text)
+            end
+          end
+
         end
 
         context "when the export dir is empty" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-cli
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Chef Software, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-08 00:00:00.000000000 Z
+date: 2021-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-cli