chef-apply 0.1.17 → 0.1.18

data/spec/unit/telemeter/sender_spec.rb

@@ -0,0 +1,140 @@
+#
+# 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 "spec_helper"
+require "chef_apply/telemeter/sender"
+require "chef_apply/config"
+
+RSpec.describe ChefApply::Telemeter::Sender do
+  let(:session_files) { %w{file1 file2} }
+  let(:enabled_flag) { true }
+  let(:dev_mode) { false }
+  let(:config) { double("config") }
+
+  let(:subject) { ChefApply::Telemeter::Sender.new(session_files) }
+
+  before do
+    allow(config).to receive(:dev).and_return dev_mode
+    allow(ChefApply::Config).to receive(:telemetry).and_return config
+    allow(ChefApply::Telemeter).to receive(:enabled?).and_return enabled_flag
+    # Ensure this is not set for each test:
+    ENV.delete("CHEF_TELEMETRY_ENDPOINT")
+  end
+
+  describe "::start_upload_thread" do
+    let(:sender_mock) { instance_double(ChefApply::Telemeter::Sender) }
+    it "spawns a thread to run the send" do
+      expect(ChefApply::Telemeter::Sender).to receive(:find_session_files).and_return session_files
+      expect(ChefApply::Telemeter::Sender).to receive(:new).with(session_files).and_return sender_mock
+      expect(sender_mock).to receive(:run)
+      expect(::Thread).to receive(:new).and_yield
+      ChefApply::Telemeter::Sender.start_upload_thread
+    end
+  end
+
+  describe "#run" do
+    before do
+      expect(subject).to receive(:session_files).and_return session_files
+    end
+
+    context "when telemetry is disabled" do
+      let(:enabled_flag) { false }
+      it "deletes session files without sending" do
+        expect(FileUtils).to receive(:rm_rf).with("file1")
+        expect(FileUtils).to receive(:rm_rf).with("file2")
+        expect(FileUtils).to receive(:rm_rf).with(ChefApply::Config.telemetry_session_file)
+        expect(subject).to_not receive(:process_session)
+        subject.run
+      end
+    end
+
+    context "when telemetry is enabled" do
+      context "and telemetry dev mode is true" do
+        let(:dev_mode) { true }
+        let(:session_files) { [] } # Ensure we don't send anything without mocking :allthecalls:
+        context "and a custom telemetry endpoint is not set" do
+          it "configures the environment to submit to the Acceptance telemetry endpoint" do
+            subject.run
+            expect(ENV["CHEF_TELEMETRY_ENDPOINT"]).to eq "https://telemetry-acceptance.chef.io"
+          end
+        end
+
+        context "and a custom telemetry endpoint is already set" do
+          before do
+            ENV["CHEF_TELEMETRY_ENDPOINT"] = "https://localhost"
+          end
+          it "should not overwrite the custom value" do
+            subject.run
+            expect(ENV["CHEF_TELEMETRY_ENDPOINT"]).to eq "https://localhost"
+          end
+        end
+      end
+
+      it "submits the session capture for each session file found" do
+        expect(subject).to receive(:process_session).with("file1")
+        expect(subject).to receive(:process_session).with("file2")
+        expect(FileUtils).to receive(:rm_rf).with(ChefApply::Config.telemetry_session_file)
+        subject.run
+      end
+    end
+
+    context "when an error occurrs" do
+      it "logs it" do
+        allow(config).to receive(:enabled?).and_raise("Failed")
+        expect(ChefApply::Log).to receive(:fatal)
+        subject.run
+      end
+    end
+  end
+
+  describe "::find_session_files" do
+    it "finds all telemetry-payload-*.yml files in the telemetry directory" do
+      expect(ChefApply::Config).to receive(:telemetry_path).and_return("/tmp")
+      expect(Dir).to receive(:glob).with("/tmp/telemetry-payload-*.yml").and_return []
+      ChefApply::Telemeter::Sender.find_session_files
+    end
+  end
+
+  describe "process_session" do
+    it "loads the sesion and submits it" do
+      expect(subject).to receive(:load_and_clear_session).with("file1").and_return({ "version" => "1.0.0", "entries" => [] })
+      expect(subject).to receive(:submit_session).with({ "version" => "1.0.0", "entries" => [] })
+      subject.process_session("file1")
+    end
+  end
+
+  describe "submit_session" do
+    let(:telemetry) { instance_double("telemetry") }
+    it "removes the telemetry session file and starts a new session, then submits each entry in the session" do
+      expect(ChefApply::Config).to receive(:telemetry_session_file).and_return("/tmp/SESSION_ID")
+      expect(FileUtils).to receive(:rm_rf).with("/tmp/SESSION_ID")
+      expect(Telemetry).to receive(:new).and_return telemetry
+      expect(subject).to receive(:submit_entry).with(telemetry, { "event" => "action1" }, 1, 2)
+      expect(subject).to receive(:submit_entry).with(telemetry, { "event" => "action2" }, 2, 2)
+      subject.submit_session( { "version" => "1.0.0",
+                                "entries" => [ { "event" => "action1" }, { "event" => "action2" } ] } )
+    end
+  end
+
+  describe "submit_entry" do
+    let(:telemetry) { instance_double("telemetry") }
+    it "submits the entry to telemetry" do
+      expect(telemetry).to receive(:deliver).with("test" => "this")
+      subject.submit_entry(telemetry, { "test" => "this" }, 1, 1)
+    end
+  end
+end

data/spec/unit/telemeter_spec.rb

@@ -0,0 +1,191 @@
+#
+# 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 "spec_helper"
+require "chef_apply/telemeter"
+
+RSpec.describe ChefApply::Telemeter do
+  subject { ChefApply::Telemeter.instance }
+  let(:host_platform) { "linux" }
+
+  before do
+    allow(subject).to receive(:host_platform).and_return host_platform
+  end
+
+  context "#commit" do
+    context "when telemetry is enabled" do
+      before do
+        allow(subject).to receive(:enabled?).and_return true
+      end
+
+      it "writes events out and clears the queue" do
+        subject.capture(:test)
+        expect(subject.pending_event_count).to eq 1
+        expect(subject).to receive(:convert_events_to_session)
+        expect(subject).to receive(:write_session)
+
+        subject.commit
+        expect(subject.pending_event_count).to eq 0
+      end
+    end
+
+    context "when telemetry is disabled" do
+      before do
+        allow(subject).to receive(:enabled?).and_return false
+      end
+      it "does not write any events and clears the queue" do
+        subject.capture(:test)
+        expect(subject.pending_event_count).to eq 1
+        expect(subject).to_not receive(:convert_events_to_session)
+
+        subject.commit
+        expect(subject.pending_event_count).to eq 0
+      end
+    end
+  end
+
+  context "#timed_action_capture" do
+    context "when a valid target_host is present" do
+      it "invokes timed_capture with action and valid target data" do
+        target = instance_double("TargetHost",
+                                 base_os: "windows",
+                                 version: "10.0.0",
+                                 architecture: "x86_64",
+                                 hostname: "My_Host",
+                                 transport_type: "winrm")
+        action = instance_double("Action::Base", name: "test_action",
+                                                 target_host: target)
+        expected_data = {
+          action: "test_action",
+          target: {
+            platform: {
+              name: "windows",
+              version: "10.0.0",
+              architecture: "x86_64"
+            },
+            hostname_sha1: Digest::SHA1.hexdigest("my_host"),
+            transport_type: "winrm"
+          }
+        }
+        expect(subject).to receive(:timed_capture).with(:action, expected_data)
+        subject.timed_action_capture(action) { :ok }
+      end
+
+      context "when a valid target_host is not present" do
+        it "invokes timed_capture with empty target values" do
+          expected_data = { action: "Base", target: { platform: {},
+                                                      hostname_sha1: nil,
+                                                      transport_type: nil } }
+          expect(subject).to receive(:timed_capture).
+            with(:action, expected_data)
+          subject.timed_action_capture(
+            ChefApply::Action::Base.new(target_host: nil)
+          ) { :ok }
+        end
+      end
+    end
+  end
+
+  context "::enabled?" do
+    let(:enabled_flag) { false }
+    let(:config) { double("config") }
+    before do
+      allow(ChefApply::Config).to receive(:telemetry).and_return(config)
+      allow(config).to receive(:enable).and_return(enabled_flag)
+    end
+
+    context "when config value is enabled" do
+      let(:enabled_flag) { true }
+      context "and CHEF_TELEMETRY_OPT_OUT is not present in env vars" do
+        it "returns false" do
+          ENV.delete("CHEF_TELEMETRY_OPT_OUT")
+          expect(subject.enabled?).to eq true
+        end
+      end
+      context "and CHEF_TELEMETRY_OPT_OUT is present in env vars" do
+        it "returns false" do
+          ENV["CHEF_TELEMETRY_OPT_OUT"] = ""
+          expect(subject.enabled?).to eq false
+        end
+      end
+    end
+
+    context "when config value is disabled" do
+      let(:enabled_flag) { false }
+      it "returns false" do
+        expect(subject.enabled?).to eq false
+      end
+    end
+  end
+
+  context "#timed_run_capture" do
+    it "invokes timed_capture with run data" do
+      expected_data = { arguments: [ "arg1" ] }
+      expect(subject).to receive(:timed_capture).
+        with(:run, expected_data)
+      subject.timed_run_capture(["arg1"])
+    end
+  end
+
+  context "#timed_capture" do
+    let(:runner) { double("capture_test") }
+    before do
+      expect(subject.pending_event_count).to eq 0
+    end
+
+    it "runs the requested thing and invokes #capture with duration" do
+      expect(runner).to receive(:do_it)
+      expect(subject).to receive(:capture) do |name, data|
+        expect(name).to eq(:do_it_test)
+        expect(data[:duration]).to be > 0.0
+      end
+      subject.timed_capture(:do_it_test) do
+        runner.do_it
+      end
+    end
+  end
+
+  context "#capture" do
+    before do
+      expect(subject.pending_event_count).to eq 0
+    end
+    it "adds the captured event to the session" do
+      subject.capture(:test, {})
+      expect(subject.pending_event_count) == 1
+    end
+  end
+
+  context "#make_event_payload" do
+    before do
+      allow(subject).to receive(:installation_id).and_return "0000"
+    end
+
+    it "adds expected properties" do
+      payload = subject.make_event_payload(:run, { hello: "world" })
+      expected_payload = {
+        event: :run,
+        properties: {
+          installation_id: "0000",
+          run_timestamp: subject.run_timestamp,
+          host_platform: host_platform,
+          event_data:  { hello: "world" }
+        }
+      }
+      expect(payload).to eq expected_payload
+    end
+  end
+end

data/spec/unit/temp_cookbook_spec.rb

@@ -0,0 +1,199 @@
+#
+# 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 "spec_helper"
+require "chef_apply/temp_cookbook"
+require "tempfile"
+require "securerandom"
+
+RSpec.describe ChefApply::TempCookbook do
+  subject(:tc) { ChefApply::TempCookbook.new }
+  let(:uuid) { SecureRandom.uuid }
+
+  before do
+    @repo_paths = ChefApply::Config.chef.cookbook_repo_paths
+    ChefApply::Config.chef.cookbook_repo_paths = []
+  end
+
+  after do
+    ChefApply::Config.chef.cookbook_repo_paths = @repo_paths
+    tc.delete
+  end
+
+  describe "#from_existing_recipe" do
+    it "raises an error if the recipe does not have a .rb extension" do
+      err = ChefApply::TempCookbook::UnsupportedExtension
+      expect { tc.from_existing_recipe("/some/file.chef") }.to raise_error(err)
+    end
+
+    context "when there is an existing cookbook" do
+      let(:cb) do
+        d = Dir.mktmpdir
+        File.open(File.join(d, "metadata.rb"), "w+") do |f|
+          f << "name \"foo\""
+        end
+        FileUtils.mkdir(File.join(d, "recipes"))
+        d
+      end
+
+      let(:existing_recipe) do
+        File.open(File.join(cb, "recipes/default.rb"), "w+") do |f|
+          f.write(uuid)
+          f
+        end
+      end
+
+      after do
+        FileUtils.remove_entry cb
+      end
+
+      it "copies the whole cookbook" do
+        tc.from_existing_recipe(existing_recipe.path)
+        expect(File.read(File.join(tc.path, "recipes/default.rb"))).to eq(uuid)
+        expect(File.read(File.join(tc.path, "Policyfile.rb"))).to eq <<~EXPECTED_POLICYFILE
+          name "foo_policy"
+          default_source :supermarket
+          run_list "foo::default"
+          cookbook "foo", path: "."
+        EXPECTED_POLICYFILE
+        expect(File.read(File.join(tc.path, "metadata.rb"))).to eq("name \"foo\"")
+      end
+    end
+
+    context "when there is only a single recipe not in a cookbook" do
+      let(:existing_recipe) do
+        t = Tempfile.new(["recipe", ".rb"])
+        t.write(uuid)
+        t.close
+        t
+      end
+
+      after do
+        existing_recipe.unlink
+      end
+
+      it "copies the existing recipe into a new cookbook" do
+        tc.from_existing_recipe(existing_recipe.path)
+        recipe_filename = File.basename(existing_recipe.path)
+        recipe_name = File.basename(recipe_filename, File.extname(recipe_filename))
+        expect(File.read(File.join(tc.path, "recipes/", recipe_filename))).to eq(uuid)
+        expect(File.read(File.join(tc.path, "Policyfile.rb"))).to eq <<~EXPECTED_POLICYFILE
+          name "cw_recipe_policy"
+          default_source :supermarket
+          run_list "cw_recipe::#{recipe_name}"
+          cookbook "cw_recipe", path: "."
+        EXPECTED_POLICYFILE
+        expect(File.read(File.join(tc.path, "metadata.rb"))).to eq("name \"cw_recipe\"\n")
+      end
+    end
+  end
+
+  describe "#from_resource" do
+    it "creates a recipe containing the supplied recipe" do
+      tc.from_resource("directory", "/tmp/foo", [])
+      expect(File.read(File.join(tc.path, "recipes/default.rb"))).to eq("directory '/tmp/foo'\n")
+    end
+  end
+
+  describe "#generate_metadata" do
+    it "generates metadata in the temp cookbook" do
+      f = tc.generate_metadata("foo")
+      expect(File.read(f)).to eq("name \"foo\"\n")
+    end
+  end
+
+  describe "#generate_policyfile" do
+    context "when there is no existing policyfile" do
+      it "generates a policyfile in the temp cookbook" do
+        f = tc.generate_policyfile("foo", "bar")
+        expect(File.read(f)).to eq <<~EXPECTED_POLICYFILE
+          name "foo_policy"
+          default_source :supermarket
+          run_list "foo::bar"
+          cookbook "foo", path: "."
+        EXPECTED_POLICYFILE
+      end
+
+      context "when there are configured cookbook_repo_paths" do
+        it "generates a policyfile in the temp cookbook" do
+          ChefApply::Config.chef.cookbook_repo_paths = %w{one two}
+          f = tc.generate_policyfile("foo", "bar")
+          expect(File.read(f)).to eq <<~EXPECTED_POLICYFILE
+            name "foo_policy"
+            default_source :chef_repo, "one"
+            default_source :chef_repo, "two"
+            default_source :supermarket
+            run_list "foo::bar"
+            cookbook "foo", path: "."
+          EXPECTED_POLICYFILE
+        end
+      end
+    end
+
+    context "when there is an existing policyfile" do
+      before do
+        File.open(File.join(tc.path, "Policyfile.rb"), "a") do |f|
+          f << "this is a policyfile"
+        end
+      end
+      it "only overrides the existing run_list in the policyfile" do
+        f = tc.generate_policyfile("foo", "bar")
+        expect(File.read(f)).to eq <<~EXPECTED_POLICYFILE
+          this is a policyfile
+          # Overriding run_list with command line specified value
+          run_list "foo::bar"
+        EXPECTED_POLICYFILE
+      end
+    end
+  end
+
+  describe "#create_resource_definition" do
+    let(:r1) { "directory" }
+    let(:r2) { "/tmp" }
+    let(:props) { nil }
+    context "when no properties are provided" do
+      it "it creates a simple resource" do
+        expect(tc.create_resource_definition(r1, r2, [])).to eq("directory '/tmp'\n")
+      end
+    end
+
+    context "when properties are provided" do
+      let(:props) do
+        {
+          "key1" => "value",
+          "key2" => 0.1,
+          "key3" => 100,
+          "key4" => true,
+          "key_with_underscore" => "value",
+        }
+      end
+
+      it "converts the properties to chef-client args" do
+        expected = <<~EXPECTED_RESOURCE
+          directory '/tmp' do
+            key1 'value'
+            key2 0.1
+            key3 100
+            key4 true
+            key_with_underscore 'value'
+          end
+        EXPECTED_RESOURCE
+        expect(tc.create_resource_definition(r1, r2, props)).to eq(expected)
+      end
+    end
+  end
+end