roku_builder 3.13.0 → 4.0.0

data/test/roku_builder/test_options_plugins.rb

@@ -0,0 +1,111 @@
+# ********** Copyright Viacom, Inc. Apache 2.0 **********
+
+require_relative "test_helper.rb"
+
+module RokuBuilder
+  class OptionsPluginTest < Minitest::Test
+    def setup
+      Logger.set_testing
+    end
+    def test_options_plugins_parse
+      RokuBuilder.class_variable_set(:@@plugins, nil)
+      parser = Minitest::Mock.new()
+      options_hash = {}
+      RokuBuilder.register_plugin( OptionsTestPlugin)
+      options = Options.allocate
+      parser.expect(:parse!, nil)
+      parser.expect(:banner=, nil, [String])
+      parser.expect(:separator, nil, [String])
+      parser.expect(:separator, nil, [String])
+      OptionParser.stub(:new, parser) do
+        options.stub(:validate_parser, nil) do
+          options_hash = options.send(:parse)
+        end
+      end
+      assert options_hash[:run]
+      parser.verify
+      RokuBuilder.class_variable_set(:@@plugins, nil)
+    end
+    def test_options_plugins_commands
+      RokuBuilder.class_variable_set(:@@plugins, nil)
+      RokuBuilder.register_plugin(OptionsTestPlugin)
+      options = Options.allocate
+      options.send(:setup_plugin_commands)
+      assert_includes options.send(:commands), :test
+      RokuBuilder.class_variable_set(:@@plugins, nil)
+    end
+    def test_options_plugins_commands_source
+      RokuBuilder.class_variable_set(:@@plugins, nil)
+      RokuBuilder.register_plugin(OptionsTestPlugin)
+      options = Options.allocate
+      options.send(:setup_plugin_commands)
+      assert_includes options.send(:source_commands), :test
+      RokuBuilder.class_variable_set(:@@plugins, nil)
+    end
+    def test_options_plugins_commands_device
+      RokuBuilder.class_variable_set(:@@plugins, nil)
+      RokuBuilder.register_plugin(OptionsTestPlugin)
+      options = Options.allocate
+      options.send(:setup_plugin_commands)
+      assert_includes options.send(:device_commands), :test
+      RokuBuilder.class_variable_set(:@@plugins, nil)
+    end
+    def test_options_plugins_commands_exclude
+      RokuBuilder.class_variable_set(:@@plugins, nil)
+      RokuBuilder.register_plugin(OptionsTestPlugin)
+      options = Options.allocate
+      options.send(:setup_plugin_commands)
+      assert_includes options.send(:exclude_commands), :test
+      RokuBuilder.class_variable_set(:@@plugins, nil)
+    end
+    def test_options_plugins_commands_basic
+      RokuBuilder.class_variable_set(:@@plugins, nil)
+      RokuBuilder.register_plugin(OptionsTestPlugin2)
+      options = Options.allocate
+      options.send(:setup_plugin_commands)
+      assert_includes options.send(:commands), :test
+      RokuBuilder.class_variable_set(:@@plugins, nil)
+    end
+    def test_options_plugins_commands_source_2
+      RokuBuilder.class_variable_set(:@@plugins, nil)
+      RokuBuilder.register_plugin(OptionsTestPlugin2)
+      options = Options.allocate
+      options.send(:setup_plugin_commands)
+      refute_includes options.send(:source_commands), :test
+      RokuBuilder.class_variable_set(:@@plugins, nil)
+    end
+    def test_options_plugins_commands_device_2
+      RokuBuilder.class_variable_set(:@@plugins, nil)
+      RokuBuilder.register_plugin(OptionsTestPlugin2)
+      options = Options.allocate
+      options.send(:setup_plugin_commands)
+      refute_includes options.send(:device_commands), :test
+      RokuBuilder.class_variable_set(:@@plugins, nil)
+    end
+    def test_options_plugins_commands_exclude_2
+      RokuBuilder.class_variable_set(:@@plugins, nil)
+      RokuBuilder.register_plugin(OptionsTestPlugin2)
+      options = Options.allocate
+      options.send(:setup_plugin_commands)
+      refute_includes options.send(:exclude_commands), :test
+      RokuBuilder.class_variable_set(:@@plugins, nil)
+    end
+  end
+  class OptionsTestPlugin
+    extend Plugin
+    def self.parse_options(parser:, options:)
+      options[:run] = true
+    end
+    def self.commands
+      {test: {device: true, source: true, exclude: true}}
+    end
+  end
+  class OptionsTestPlugin2
+    extend Plugin
+    def self.parse_options(parser:, options:)
+    end
+    def self.commands
+      {test: {}}
+    end
+  end
+end

data/test/roku_builder/test_plugin.rb

@@ -0,0 +1,48 @@
+# ********** Copyright Viacom, Inc. Apache 2.0 **********
+
+require_relative "test_helper.rb"
+
+module RokuBuilder
+  class PluginTest < Minitest::Test
+    def setup
+      Logger.set_testing
+    end
+    def test_module_commands_fail
+      assert_raises ImplementationError do
+        TestClass.commands
+      end
+    end
+    def test_module_commands_success
+      TestClass2.commands
+    end
+    def test_module_parse_options_fail
+      assert_raises ImplementationError do
+        TestClass.parse_options(option_parser: nil, options: nil)
+      end
+    end
+    def test_module_parse_options_success
+      TestClass2.parse_options(option_parser: nil, options: nil)
+    end
+    def test_module_dependencies
+      assert_equal Array, TestClass.dependencies.class
+    end
+    def test_module_dependencies_dependent
+      assert_equal Array, TestClass2.dependencies.class
+      assert_equal TestClass, TestClass2.dependencies[0]
+    end
+  end
+  class TestClass
+    extend Plugin
+  end
+  class TestClass2
+    extend Plugin
+    def self.commands
+    end
+    def self.parse_options(option_parser:, options:)
+    end
+    def self.dependencies
+      [TestClass]
+    end
+  end
+end
+

data/test/roku_builder/test_roku_builder.rb

@@ -0,0 +1,239 @@
+# ********** Copyright Viacom, Inc. Apache 2.0 **********
+
+require_relative "test_helper.rb"
+
+module RokuBuilder
+  class RokuBuilderTest < Minitest::Test
+    def setup
+      Logger.set_testing
+      RokuBuilder.class_variable_set(:@@plugins, [])
+      @ping = Minitest::Mock.new
+      @options = build_options({validate: true, device_given: false, working: true})
+      @options.define_singleton_method(:device_commands){
+        [:validate]
+      }
+      @raw = {
+        devices: {
+        a: {ip: "2.2.2.2"},
+        b: {ip: "3.3.3.3"}
+      }
+      }
+      @parsed = {
+        device_config: {ip: "1.1.1.1"}
+      }
+      @config = Config.new(options: @options)
+      @config.instance_variable_set(:@config, @raw)
+      @config.instance_variable_set(:@parsed, @parsed)
+      RokuBuilder.class_variable_set(:@@options, @options)
+      RokuBuilder.class_variable_set(:@@config, @config)
+    end
+    def teardown
+      @ping.verify
+      RokuBuilder.class_variable_set(:@@plugins, [])
+    end
+
+    def test_roku_builder_run
+      config = File.join(test_files_path(RokuBuilderTest), "config.json")
+      RokuBuilder.run(options: {validate: true, config: config})
+    end
+    def test_roku_builder_run_stage
+      config = File.join(test_files_path(RokuBuilderTest), "config.json")
+      commands = Minitest::Mock.new
+      commands.expect(:call, {validate: {stage: true}})
+      commands.expect(:call, {validate: {stage: true}})
+      commands.expect(:call, {validate: {stage: true}})
+      commands.expect(:call, {validate: {stage: true}})
+      Core.stub(:commands, commands) do
+        RokuBuilder.run(options: {validate: true, config: config})
+      end
+    end
+    def test_roku_builder_run_debug
+      config = File.join(test_files_path(RokuBuilderTest), "config.json")
+      RokuBuilder.run(options: {validate: true, debug: true, config: config})
+    end
+    def test_roku_builder_run_bad_options
+      RokuBuilder.class_variable_set(:@@plugins, [])
+      logger = Minitest::Mock.new
+      logger.expect(:fatal, nil, ["RokuBuilder::InvalidOptions: Specify at least one command"])
+      Logger.class_variable_set(:@@instance, logger)
+      RokuBuilder.run(options: {working: true})
+      logger.verify
+      Logger.set_testing
+    end
+    def test_roku_builder_run_bad_options_debug
+      config = File.join(test_files_path(RokuBuilderTest), "config.json")
+      RokuBuilder.class_variable_set(:@@plugins, [])
+      RokuBuilder.setup_plugins
+      register_plugins(Packager)
+      assert_raises DeviceError do
+        RokuBuilder.run(options: {package: true, in: "/in/path", debug: true, config: config})
+      end
+    end
+    def test_roku_builder_run_bad_config
+      config = File.join(test_files_path(RokuBuilderTest), "missing_config.json")
+      logger = Minitest::Mock.new
+      logger.expect(:level=, nil, [::Logger::WARN])
+      logger.expect(:fatal, nil, ["ArgumentError: Missing Config"])
+      Logger.class_variable_set(:@@instance, logger)
+      RokuBuilder.run(options: {validate: true, config: config})
+      logger.verify
+      Logger.set_testing
+    end
+    def test_roku_builder_check_devices_good
+      Net::Ping::External.stub(:new, @ping) do
+        @ping.expect(:ping?, true, [@parsed[:device_config][:ip], 1, 0.2, 1])
+        RokuBuilder.check_devices
+      end
+    end
+    def test_roku_builder_check_devices_no_devices
+      Net::Ping::External.stub(:new, @ping) do
+        @ping.expect(:ping?, false, [@parsed[:device_config][:ip], 1, 0.2, 1])
+        @ping.expect(:ping?, false, [@raw[:devices][:a][:ip], 1, 0.2, 1])
+        @ping.expect(:ping?, false, [@raw[:devices][:b][:ip], 1, 0.2, 1])
+        assert_raises DeviceError do
+          RokuBuilder.check_devices
+        end
+      end
+    end
+    def test_roku_builder_check_devices_changed_device
+      Net::Ping::External.stub(:new, @ping) do
+        @ping.expect(:ping?, false, [@parsed[:device_config][:ip], 1, 0.2, 1])
+        @ping.expect(:ping?, true, [@raw[:devices][:a][:ip], 1, 0.2, 1])
+        RokuBuilder.check_devices
+        assert_equal @raw[:devices][:a][:ip], @config.parsed[:device_config][:ip]
+      end
+    end
+    def test_roku_builder_check_devices_bad_device
+      Net::Ping::External.stub(:new, @ping) do
+        @options[:device_given] = true
+        @ping.expect(:ping?, false, [@parsed[:device_config][:ip], 1, 0.2, 1])
+        assert_raises DeviceError do
+          RokuBuilder.check_devices
+        end
+      end
+    end
+    def test_roku_builder_check_devices
+      Net::Ping::External.stub(:new, @ping) do
+        @options = build_options({validate: true, device_given: false, working: true})
+        RokuBuilder.class_variable_set(:@@options, @options)
+        RokuBuilder.check_devices
+      end
+    end
+
+    def test_roku_builder_logger_debug
+      tests = [
+        {options: {debug: true}, method: :set_debug},
+        {options: {verbose: true}, method: :set_info},
+        {options: {}, method: :set_warn}
+      ]
+      tests.each do |test|
+        logger = Minitest::Mock.new
+        logger.expect(:call, nil)
+
+        Logger.stub(test[:method], logger) do
+          RokuBuilder.class_variable_set(:@@options, test[:options])
+          RokuBuilder.initialize_logger
+        end
+
+        logger.verify
+      end
+    end
+    def test_roku_builder_options_parse_simple
+      options = "a:b, c:d"
+      options = RokuBuilder.options_parse(options: options)
+      refute_nil options[:a]
+      refute_nil options[:c]
+      assert_equal "b", options[:a]
+      assert_equal "d", options[:c]
+    end
+    def test_roku_builder_options_parse_complex
+      options = "a:b:c, d:e:f"
+      options = RokuBuilder.options_parse(options: options)
+      refute_nil options[:a]
+      refute_nil options[:d]
+      assert_equal "b:c", options[:a]
+      assert_equal "e:f", options[:d]
+    end
+    def test_roku_builder_plugins_empty
+      RokuBuilder.class_variable_set(:@@plugins, nil)
+      RokuBuilder.process_plugins
+      assert_equal Array, RokuBuilder.plugins.class
+      assert_equal 0, RokuBuilder.plugins.count
+    end
+    def test_roku_builder_plugins_empty_no_setup
+      RokuBuilder.class_variable_set(:@@plugins, nil)
+      assert_equal Array, RokuBuilder.plugins.class
+      assert_equal 0, RokuBuilder.plugins.count
+    end
+    def test_roku_builder_plugins_registered
+      RokuBuilder.class_variable_set(:@@plugins, nil)
+      RokuBuilder.register_plugin(TestPlugin)
+      RokuBuilder.process_plugins
+      assert_equal Array, RokuBuilder.plugins.class
+      assert_equal 1, RokuBuilder.plugins.count
+      assert_equal TestPlugin, RokuBuilder.plugins[0]
+    end
+    def test_roku_builder_plugins_duplicate_classes
+      RokuBuilder.register_plugin(TestPlugin)
+      RokuBuilder.register_plugin(TestPlugin)
+      assert_raises ImplementationError do
+        RokuBuilder.process_plugins
+      end
+    end
+    def test_roku_builder_plugins_dependencies
+      RokuBuilder.register_plugin(TestPlugin)
+      RokuBuilder.register_plugin(TestPlugin3)
+      RokuBuilder.process_plugins
+    end
+    def test_roku_builder_plugins_dependencies_missing
+      RokuBuilder.register_plugin(TestPlugin3)
+      assert_raises ImplementationError do
+        RokuBuilder.process_plugins
+      end
+    end
+    def test_roku_builder_plugins_missing_command_method
+      RokuBuilder.register_plugin(TestPlugin4)
+      assert_raises ImplementationError do
+        RokuBuilder.process_plugins
+      end
+    end
+    def test_roku_builder_load_config
+      config = Minitest::Mock.new
+      config.expect(:configure, nil)
+      config.expect(:load, nil)
+      config.expect(:validate, nil)
+      config.expect(:parse, nil)
+      Config.stub(:new, config) do
+        RokuBuilder.class_variable_set(:@@options, {})
+        RokuBuilder.load_config
+        assert config === RokuBuilder.class_variable_get(:@@config)
+      end
+      config.verify
+    end
+  end
+  class TestPlugin
+    extend Plugin
+    def self.commands
+      {}
+    end
+  end
+  class TestPlugin2
+    extend Plugin
+  end
+  class TestPlugin3
+    extend Plugin
+    def self.commands
+      {}
+    end
+    def self.dependencies
+      [TestPlugin]
+    end
+  end
+  class TestPlugin4
+    extend Plugin
+    def self.commands
+      {test: {}}
+    end
+  end
+end
+

data/test/roku_builder/test_stager.rb

@@ -4,64 +4,56 @@ require_relative "test_helper.rb"
 
 module RokuBuilder
   class StagerTest < Minitest::Test
+    def setup
+      Logger.set_testing
+    end
+
+    def build_config_options(options)
+      @options = build_options(options)
+      @options.define_singleton_method(:source_commands) {[:validate]}
+      @config = RokuBuilder::Config.new(options: @options)
+      @config.instance_variable_set(:@config, good_config(StagerTest))
+      @config.parse
+    end
 
     def test_stager_method
-      root_dir = File.join(File.dirname(__FILE__), "test_files", "stager_test")
-      stager_config = {
-        method: :working,
-        root_dir: root_dir
-      }
-      stager = Stager.new(**stager_config)
-      assert_equal stager_config[:method], stager.method
+      build_config_options({validate: true, working: true})
+      stager = Stager.new(config: @config, options: @options)
+      assert_equal :working, stager.method
     end
 
     def test_stager_stage_working
-      root_dir = File.join(File.dirname(__FILE__), "test_files", "stager_test")
-      stager_config = {
-        method: :working,
-        root_dir: root_dir
-      }
-      stager = Stager.new(**stager_config)
+      build_config_options({validate: true, working: true})
+      stager = Stager.new(config: @config, options: @options)
       assert stager.stage
       assert stager.unstage
     end
 
     def test_stager_stage_current
-      root_dir = File.join(File.dirname(__FILE__), "test_files", "stager_test")
-      stager_config = {
-        method: :current,
-        root_dir: root_dir
-      }
-      stager = Stager.new(**stager_config)
+      Pathname.stub(:pwd, test_files_path(StagerTest)) do
+        build_config_options({validate: true, current: true})
+      end
+      stager = Stager.new(config: @config, options: @options)
       assert stager.stage
       assert stager.unstage
     end
 
     def test_stager_stage_in
-      root_dir = File.join(File.dirname(__FILE__), "test_files", "stager_test")
-      stager_config = {
-        method: :in,
-        root_dir: root_dir
-      }
-      stager = Stager.new(**stager_config)
+      in_file = File.join(test_files_path(StagerTest), "test.zip")
+      build_config_options({validate: true, in: in_file})
+      stager = Stager.new(config: @config, options: @options)
       assert stager.stage
       assert stager.unstage
     end
 
     def test_stager_stage_git_stash
-      root_dir = File.join(File.dirname(__FILE__), "test_files", "stager_test")
-      branch_name = 'branch'
+      branch_name = 'production'
+      build_config_options({validate: true, stage: "production"})
       git = Minitest::Mock.new
       branch = Minitest::Mock.new
       stashes = Minitest::Mock.new
       stash = Minitest::Mock.new
 
-      stager_config = {
-        method: :git,
-        root_dir: root_dir,
-        key: branch_name
-      }
-
       git.expect(:current_branch, 'other_branch')
       git.expect(:current_branch, 'other_branch')
       git.expect(:branch, branch)
@@ -77,7 +69,7 @@ module RokuBuilder
       stashes.expect(:pop, nil, ["stash@{0}"])
 
       Git.stub(:open, git) do
-        stager = Stager.new(**stager_config)
+        stager = Stager.new(config: @config, options: @options)
         assert stager.stage
         assert stager.unstage
       end
@@ -88,18 +80,12 @@ module RokuBuilder
     end
 
     def test_stager_stage_git_no_stash
-      root_dir = File.join(File.dirname(__FILE__), "test_files", "stager_test")
-      branch_name = 'branch'
+      branch_name = 'production'
+      build_config_options({validate: true, stage: "production"})
       git = Minitest::Mock.new
       branch = Minitest::Mock.new
       stashes = Minitest::Mock.new
 
-      stager_config = {
-        method: :git,
-        root_dir: root_dir,
-        key: branch_name
-      }
-
       git.expect(:current_branch, 'other_branch')
       git.expect(:current_branch, 'other_branch')
       git.expect(:branch, branch)
@@ -112,7 +98,7 @@ module RokuBuilder
       branch.expect(:stashes, [])
 
       Git.stub(:open, git) do
-        stager = Stager.new(**stager_config)
+        stager = Stager.new(config: @config, options: @options)
         assert stager.stage
         assert stager.unstage
       end
@@ -122,19 +108,12 @@ module RokuBuilder
     end
 
     def test_stager_stage_git_error_stage
-      root_dir = File.join(File.dirname(__FILE__), "test_files", "stager_test")
-      branch_name = 'branch'
+      build_config_options({validate: true, stage: "production"})
       git = Minitest::Mock.new
       branch = Minitest::Mock.new
       stashes = Minitest::Mock.new
       stash = Minitest::Mock.new
 
-      stager_config = {
-        method: :git,
-        root_dir: root_dir,
-        key: branch_name
-      }
-
       def git.checkout(branch)
         raise Git::GitExecuteError.new
       end
@@ -152,7 +131,7 @@ module RokuBuilder
       stashes.expect(:pop, nil, ["stash@{0}"])
 
       Git.stub(:open, git) do
-        stager = Stager.new(**stager_config)
+        stager = Stager.new(config: @config, options: @options)
         assert !stager.stage
         assert stager.unstage
       end
@@ -163,16 +142,10 @@ module RokuBuilder
     end
 
     def test_stager_stage_git_error_unstage
-      root_dir = File.join(File.dirname(__FILE__), "test_files", "stager_test")
-      branch_name = 'branch'
+      build_config_options({validate: true, stage: "production"})
       git = Minitest::Mock.new
       logger = Minitest::Mock.new
 
-      stager_config = {
-        method: :git,
-        root_dir: root_dir,
-        key: branch_name
-      }
       Logger.class_variable_set(:@@instance, logger)
 
       def git.checkout(branch)
@@ -182,7 +155,7 @@ module RokuBuilder
       logger.expect(:error, nil, ["Branch or ref does not exist"])
 
       Git.stub(:open, git) do
-        stager = Stager.new(**stager_config)
+        stager = Stager.new(config: @config, options: @options)
         stager.instance_variable_set(:@current_branch, "branch")
         assert !stager.unstage
       end
@@ -191,34 +164,14 @@ module RokuBuilder
       Logger.set_testing
     end
 
-    def test_stager_stage_script
-      root_dir = File.join(File.dirname(__FILE__), "test_files", "stager_test")
-      stager_config = {
-        method: :script,
-        key: {stage: "stage_script", unstage: "unstage_script"},
-        root_dir: root_dir
-      }
-      Controller.stub(:system, nil) do
-        stager = Stager.new(**stager_config)
-        assert stager.stage
-        assert stager.unstage
-      end
-    end
-
     def test_stager_save_state
-      root_dir = File.join(File.dirname(__FILE__), "test_files", "stager_test")
-      branch_name = 'branch'
+      branch_name = 'production'
+      build_config_options({validate: true, stage: "production"})
       git = Minitest::Mock.new
       branch = Minitest::Mock.new
       stashes = Minitest::Mock.new
       pstore = Minitest::Mock.new
 
-      stager_config = {
-        method: :git,
-        root_dir: root_dir,
-        key: branch_name
-      }
-
       git.expect(:current_branch, 'other_branch')
       git.expect(:current_branch, 'other_branch')
       git.expect(:branch, branch)
@@ -234,7 +187,7 @@ module RokuBuilder
 
       Git.stub(:open, git) do
         PStore.stub(:new, pstore) do
-          stager = Stager.new(**stager_config)
+          stager = Stager.new(config: @config, options: @options)
           assert stager.stage
         end
       end
@@ -245,20 +198,13 @@ module RokuBuilder
     end
 
     def test_stager_load_state
-      root_dir = File.join(File.dirname(__FILE__), "test_files", "stager_test")
-      branch_name = 'branch'
+      build_config_options({validate: true, stage: "production"})
       git = Minitest::Mock.new
       branch = Minitest::Mock.new
       stashes = Minitest::Mock.new
       stash = Minitest::Mock.new
       pstore = Minitest::Mock.new
 
-      stager_config = {
-        method: :git,
-        root_dir: root_dir,
-        key: branch_name
-      }
-
       pstore.expect(:transaction, nil) do |&block|
       block.call
       end
@@ -276,7 +222,7 @@ module RokuBuilder
 
       Git.stub(:open, git) do
         PStore.stub(:new, pstore) do
-          stager = Stager.new(**stager_config)
+          stager = Stager.new(config: @config, options: @options)
           assert stager.unstage
         end
       end
@@ -288,8 +234,7 @@ module RokuBuilder
     end
 
     def test_stager_load_second_state
-      root_dir = File.join(File.dirname(__FILE__), "test_files", "stager_test")
-      branch_name = 'branch'
+      build_config_options({validate: true, stage: "production"})
       git = Minitest::Mock.new
       branch = Minitest::Mock.new
       stashes = Minitest::Mock.new
@@ -297,12 +242,6 @@ module RokuBuilder
       other_stash = Minitest::Mock.new
       pstore = Minitest::Mock.new
 
-      stager_config = {
-        method: :git,
-        root_dir: root_dir,
-        key: branch_name
-      }
-
       pstore.expect(:transaction, nil) do |&block|
       block.call
       end
@@ -321,7 +260,7 @@ module RokuBuilder
 
       Git.stub(:open, git) do
         PStore.stub(:new, pstore) do
-          stager = Stager.new(**stager_config)
+          stager = Stager.new(config: @config, options: @options)
           assert stager.unstage
         end
       end
@@ -332,5 +271,14 @@ module RokuBuilder
       other_stash.verify
       pstore.verify
     end
+    def test_stager_stage_script
+      build_config_options({validate: true, stage: "production", project: "project2"})
+      RokuBuilder.stub(:system, nil) do
+        stager = Stager.new(config: @config, options: @options)
+        assert stager.stage
+        assert stager.unstage
+      end
+    end
+
   end
 end