chef-apply 0.4.6 → 0.4.9

data/spec/unit/telemeter/sender_spec.rb

@@ -1,140 +0,0 @@
-#
-# 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

@@ -1,191 +0,0 @@
-#
-# 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/text/error_translation_spec.rb

@@ -1,109 +0,0 @@
-#
-# 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 "spec_helper"
-require "chef_apply/text"
-
-RSpec.describe ChefApply::Text::ErrorTranslation do
-
-  let(:display_defaults) do
-    {
-    decorations: true,
-    header: true,
-    footer: true,
-    stack: false,
-    log: false }
-  end
-
-  let(:error_table) do
-    { display_defaults: display_defaults,
-      TESTERROR: test_error }
-  end
-
-  let(:test_error_text) { "This is a test error" }
-  let(:test_error) { {} }
-
-  subject { ChefApply::Text::ErrorTranslation }
-  let(:error_mock) do
-    double("R18n::Translated",
-      text: test_error_text )
-  end
-  let(:translation_mock) do
-    double("R18n::Translated",
-      TESTERROR: error_mock,
-      text: test_error_text )
-  end
-  before do
-    # Mock out the R18n portion - our methods care only that the key exists, and
-    # the test focus is on the display metadata.
-    allow(ChefApply::Text).to receive(:errors).and_return translation_mock
-    allow(ChefApply::Text).to receive(:_error_table).and_return(error_table)
-  end
-
-  context "when some display attributes are specified" do
-    let(:test_error) { { display: { stack: true, log: true } } }
-    it "sets display attributes to specified values and defaults remaining" do
-      translation = subject.new("TESTERROR")
-      expect(translation.decorations).to be true
-      expect(translation.header).to be true
-      expect(translation.footer).to be true
-      expect(translation.stack).to be true
-      expect(translation.log).to be true
-      expect(translation.message).to eq test_error_text
-    end
-  end
-
-  context "when all display attributes are specified" do
-    let(:test_error) do
-      { display: { decorations: false, header: false,
-                   footer: false, stack: true, log: true } }
-    end
-    it "sets display attributes to specified values with no defaults" do
-      translation = subject.new("TESTERROR")
-      expect(translation.decorations).to be false
-      expect(translation.header).to be false
-      expect(translation.footer).to be false
-      expect(translation.stack).to be true
-      expect(translation.log).to be true
-      expect(translation.message).to eq test_error_text
-    end
-  end
-
-  context "when no attributes for an error are specified" do
-    let(:test_error) { {} }
-    it "sets display attribute to default values and references the correct message" do
-      translation = subject.new("TESTERROR")
-      expect(translation.decorations).to be true
-      expect(translation.header).to be true
-      expect(translation.footer).to be true
-      expect(translation.stack).to be false
-      expect(translation.log).to be false
-      expect(translation.message).to eq test_error_text
-    end
-  end
-
-  context "when invalid attributes for an error are specified" do
-    let(:test_error) { { display: { bad_value: true } } }
-    it "raises InvalidDisplayAttributes when invalid attributes are specified" do
-      expect { subject.new("TESTERROR") }
-        .to raise_error(ChefApply::Text::ErrorTranslation::InvalidDisplayAttributes) do |e|
-          expect(e.invalid_attrs).to eq({ bad_value: true })
-        end
-
-    end
-  end
-end

data/spec/unit/ui/error_printer_spec.rb

@@ -1,196 +0,0 @@
-#
-# 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/ui/error_printer"
-require "chef_apply/text/error_translation"
-require "chef_apply/errors/standard_error_resolver"
-require "chef_apply/target_host"
-
-RSpec.describe ChefApply::UI::ErrorPrinter do
-
-  let(:orig_exception) { StandardError.new("test") }
-  let(:target_host) { ChefApply::TargetHost.mock_instance("mock://localhost") }
-  let(:wrapped_exception) { ChefApply::WrappedError.new(orig_exception, target_host) }
-
-  let(:show_footer) { true }
-  let(:show_log) { true }
-  let(:show_stack) { true }
-  let(:has_decorations) { true }
-  let(:show_header) { true }
-  let(:translation_mock) do
-    instance_double("ChefApply::Errors::ErrorTranslation",
-      footer: show_footer,
-      log: show_log,
-      stack: show_stack,
-      header: show_header,
-      decorations: has_decorations)
-  end
-  subject { ChefApply::UI::ErrorPrinter.new(wrapped_exception, nil) }
-
-  before do
-    allow(ChefApply::Text::ErrorTranslation).to receive(:new).and_return translation_mock
-  end
-
-  context "#format_error" do
-
-    context "and the message has decorations" do
-      let(:has_decorations)  { true }
-      it "formats the message using the correct method" do
-        expect(subject).to receive(:format_decorated).and_return "decorated"
-        subject.format_error
-      end
-    end
-
-    context "and the message does not have decorations" do
-      let(:has_decorations)  { false }
-      it "formats the message using the correct method" do
-        expect(subject).to receive(:format_undecorated).and_return "undecorated"
-        subject.format_error
-      end
-    end
-  end
-
-  context "#format_body" do
-    RC = ChefApply::TargetHost
-    context "when exception is a ChefApply::Error" do
-      let(:result) { RemoteExecResult.new(1, "", "failed") }
-      let(:orig_exception) { RC::RemoteExecutionFailed.new("localhost", "test", result) }
-      it "invokes the right handler" do
-        expect(subject).to receive(:format_workstation_exception)
-        subject.format_body
-      end
-    end
-
-    context "when exception is a Train::Error" do
-      # These may expand as we find error-specific messaging we can provide to customers
-      # for more specific train exceptions
-      let(:orig_exception) { Train::Error.new("test") }
-      it "invokes the right handler" do
-        expect(subject).to receive(:format_train_exception)
-        subject.format_body
-      end
-    end
-
-    context "when exception is something else" do
-      # These may expand as we find error-specific messaging we can provide to customers
-      # for more specific general exceptions
-      it "invokes the right handler" do
-        expect(subject).to receive(:format_other_exception)
-        subject.format_body
-      end
-    end
-  end
-
-  context ".show_error" do
-    subject { ChefApply::UI::ErrorPrinter }
-    context "when handling a MultiJobFailure" do
-      it "recognizes it and invokes capture_multiple_failures" do
-        underlying_error = ChefApply::MultiJobFailure.new([])
-        error_to_process = ChefApply::Errors::StandardErrorResolver.wrap_exception(underlying_error)
-        expect(subject).to receive(:capture_multiple_failures).with(underlying_error)
-        subject.show_error(error_to_process)
-
-      end
-    end
-
-    context "when an error occurs in error handling" do
-      it "processes the new failure with dump_unexpected_error" do
-        error_to_raise = StandardError.new("this will be raised")
-        error_to_process = ChefApply::Errors::StandardErrorResolver.wrap_exception(StandardError.new("this is being shown"))
-        # Intercept a known call to raise an error
-        expect(ChefApply::UI::Terminal).to receive(:output).and_raise error_to_raise
-        expect(subject).to receive(:dump_unexpected_error).with(error_to_raise)
-        subject.show_error(error_to_process)
-      end
-    end
-
-  end
-
-  context ".capture_multiple_failures" do
-    subject { ChefApply::UI::ErrorPrinter }
-    let(:file_content_capture) { StringIO.new }
-    before do
-      allow(ChefApply::Config).to receive(:error_output_path).and_return "/dev/null"
-      allow(File).to receive(:open).with("/dev/null", "w").and_yield(file_content_capture)
-    end
-
-    it "should write a properly formatted error file" do
-      # TODO - add support for test-only i18n content, so that we don't have
-      #        to rely on specific known error IDs that may change or be removed,
-      #        and arent' directly relevant to the test at hand.
-      job1 = double("Job", target_host: double("TargetHost", hostname: "host1"),
-                           exception: ChefApply::Error.new("CHEFUPL005"))
-      job2 = double("Job", target_host: double("TargetHost", hostname: "host2"),
-                           exception: StandardError.new("Hello World"))
-
-      expected_content = File.read("spec/unit/fixtures/multi-error.out")
-      multifailure = ChefApply::MultiJobFailure.new([job1, job2] )
-      subject.capture_multiple_failures(multifailure)
-      expect(file_content_capture.string).to eq expected_content
-    end
-  end
-
-  context "#format_footer" do
-    let(:formatter) do
-      ChefApply::UI::ErrorPrinter.new(wrapped_exception, nil)
-    end
-
-    subject do
-      lambda { formatter.format_footer }
-    end
-
-    context "when both log and stack wanted" do
-      let(:show_log) { true }
-      let(:show_stack) { true }
-      assert_string_lookup("errors.footer.both")
-    end
-
-    context "when only log is wanted" do
-      let(:show_log) { true }
-      let(:show_stack) { false }
-      assert_string_lookup("errors.footer.log_only")
-    end
-
-    context "when only stack is wanted" do
-      let(:show_log) { false }
-      let(:show_stack) { true }
-      assert_string_lookup("errors.footer.stack_only")
-    end
-
-    context "when neither log nor stack wanted" do
-      let(:show_log) { false }
-      let(:show_stack) { false }
-      assert_string_lookup("errors.footer.neither")
-    end
-  end
-
-  context ".write_backtrace" do
-    let(:inst) { double(ChefApply::UI::ErrorPrinter) }
-    before do
-      allow(ChefApply::UI::ErrorPrinter).to receive(:new).and_return inst
-    end
-
-    let(:orig_args) { %w{test} }
-    it "formats and saves the backtrace" do
-      expect(inst).to receive(:add_backtrace_header).with(anything, orig_args)
-      expect(inst).to receive(:add_formatted_backtrace)
-      expect(inst).to receive(:save_backtrace)
-      ChefApply::UI::ErrorPrinter.write_backtrace(wrapped_exception, orig_args)
-    end
-  end
-end