roku_builder 4.25.4 → 4.26.0

data/test/roku_builder/plugins/test_tester.rb

@@ -11,6 +11,8 @@ module RokuBuilder
       @connection = Minitest::Mock.new
       @requests = []
 
+      @device_manager = Minitest::Mock.new
+
       @requests.push(stub_request(:post, "http://192.168.0.100:8060/keypress/Home").
         to_return(status: 200, body: "", headers: {}))
       @requests.push(stub_request(:post, "http://192.168.0.100/plugin_install").
@@ -19,6 +21,7 @@ module RokuBuilder
         to_return(status: 200, body: "", headers: {}))
     end
     def teardown
+      @device_manager.verify
       @connection.verify
       @requests.each {|req| remove_request_stub(req)}
     end
@@ -37,8 +40,14 @@ module RokuBuilder
       @connection.expect(:waitfor, nil, [/\*+\s*End testing\s*\*+/])
       @connection.expect(:puts, nil, ["cont\n"])
 
-      Net::Telnet.stub(:new, @connection) do
-        tester.test(options: options)
+      device = RokuBuilder::Device.new("roku", config.raw[:devices][:roku])
+      @device_manager.expect(:reserve_device, device, no_lock: false)
+      @device_manager.expect(:release_device, nil, [device])
+
+      RokuBuilder.stub(:device_manager, @device_manager) do
+        Net::Telnet.stub(:new, @connection) do
+          tester.test(options: options)
+        end
       end
     end
 
@@ -55,9 +64,15 @@ module RokuBuilder
       @connection.expect(:waitfor, nil, &waitfor)
       @connection.expect(:puts, nil, ["cont\n"])
 
-      Net::Telnet.stub(:new, @connection) do
-        tester.stub(:handle_text, false) do
-          tester.test(options: options)
+      device = RokuBuilder::Device.new("roku", config.raw[:devices][:roku])
+      @device_manager.expect(:reserve_device, device, no_lock: false)
+      @device_manager.expect(:release_device, nil, [device])
+
+      RokuBuilder.stub(:device_manager, @device_manager) do
+        Net::Telnet.stub(:new, @connection) do
+          tester.stub(:handle_text, false) do
+            tester.test(options: options)
+          end
         end
       end
     end

data/test/roku_builder/test_device_manager.rb

@@ -0,0 +1,187 @@
+# ********** Copyright Viacom, Inc. Apache 2.0 **********
+
+require_relative "test_helper.rb"
+
+module RokuBuilder
+  class DeviceManagerTest < Minitest::Test
+    def setup
+      Logger.set_testing
+      @ping = Minitest::Mock.new
+      clean_device_locks(["roku", "test2"])
+    end
+
+    def teardown
+      @ping.verify
+      clean_device_locks(["roku", "test2"])
+    end
+
+    def test_device_manager_init
+      config, options = build_config_options_objects(DeviceManagerTest)
+      manager = DeviceManager.new(config: config, options: options)
+      assert_equal config, manager.instance_variable_get(:@config)
+      assert_equal options, manager.instance_variable_get(:@options)
+    end
+
+    def test_device_manager_reserve_device
+      Net::Ping::External.stub(:new, @ping) do
+        config, options = build_config_options_objects(DeviceManagerTest)
+        @ping.expect(:ping?, true, [config.raw[:devices][:roku][:ip], 1, 0.2, 1])
+        manager = DeviceManager.new(config: config, options: options)
+        device = manager.reserve_device
+        assert_kind_of Device, device
+        assert_equal "roku", device.name
+      end
+    end
+
+    def test_device_manager_reserve_device_default_offline
+      Net::Ping::External.stub(:new, @ping) do
+        config, options = build_config_options_objects(DeviceManagerTest)
+        @ping.expect(:ping?, false, [config.raw[:devices][:roku][:ip], 1, 0.2, 1])
+        manager = DeviceManager.new(config: config, options: options)
+        assert_raises(DeviceError) do
+          device = manager.reserve_device
+        end
+      end
+    end
+
+    def test_device_manager_reserve_device_all_used
+      Net::Ping::External.stub(:new, @ping) do
+        config, options = build_config_options_objects(DeviceManagerTest)
+        @ping.expect(:ping?, true, [config.raw[:devices][:roku][:ip], 1, 0.2, 1])
+        @ping.expect(:ping?, true, [config.raw[:devices][:roku][:ip], 1, 0.2, 1])
+        manager = DeviceManager.new(config: config, options: options)
+        device1 = manager.reserve_device
+        assert_raises(DeviceError) do
+          device2 = manager.reserve_device
+        end
+      end
+    end
+
+    def test_device_manager_reserve_device_no_lock_first
+      Net::Ping::External.stub(:new, @ping) do
+        config, options = build_config_options_objects(DeviceManagerTest)
+        @ping.expect(:ping?, true, [config.raw[:devices][:roku][:ip], 1, 0.2, 1])
+        @ping.expect(:ping?, true, [config.raw[:devices][:roku][:ip], 1, 0.2, 1])
+        manager = DeviceManager.new(config: config, options: options)
+        device1 = manager.reserve_device(no_lock: true)
+        device2 = manager.reserve_device
+        assert_equal "roku", device1.name
+        assert_equal "roku", device2.name
+      end
+    end
+
+    def test_device_manager_release_device
+      Net::Ping::External.stub(:new, @ping) do
+        config, options = build_config_options_objects(DeviceManagerTest)
+        @ping.expect(:ping?, true, [config.raw[:devices][:roku][:ip], 1, 0.2, 1])
+        @ping.expect(:ping?, true, [config.raw[:devices][:roku][:ip], 1, 0.2, 1])
+        manager = DeviceManager.new(config: config, options: options)
+        device1 = manager.reserve_device
+        manager.release_device(device1)
+        device2 = manager.reserve_device
+        assert_equal "roku", device2.name
+      end
+    end
+
+    def test_device_manager_reserve_device_2_devices
+      Net::Ping::External.stub(:new, @ping) do
+        options = {validate: true}
+        config = good_config(DeviceManagerTest)
+        config[:devices][:test2] = {
+          ip: "192.168.0.101",
+          user: "user",
+          password: "password"
+        }
+        config, options = build_config_options_objects(DeviceManagerTest, options, true, config)
+        @ping.expect(:ping?, true, [config.raw[:devices][:roku][:ip], 1, 0.2, 1])
+        @ping.expect(:ping?, true, [config.raw[:devices][:roku][:ip], 1, 0.2, 1])
+        @ping.expect(:ping?, true, [config.raw[:devices][:test2][:ip], 1, 0.2, 1])
+        manager = DeviceManager.new(config: config, options: options)
+        device1 = manager.reserve_device
+        device2 = manager.reserve_device
+        assert_equal "roku", device1.name
+        assert_equal "test2", device2.name
+      end
+    end
+
+    def test_device_manager_reserve_device_2_devices_default_missing
+      Net::Ping::External.stub(:new, @ping) do
+        options = {validate: true}
+        config = good_config(DeviceManagerTest)
+        config[:devices][:test2] = {
+          ip: "192.168.0.101",
+          user: "user",
+          password: "password"
+        }
+        config, options = build_config_options_objects(DeviceManagerTest, options, true, config)
+        @ping.expect(:ping?, false, [config.raw[:devices][:roku][:ip], 1, 0.2, 1])
+        @ping.expect(:ping?, true, [config.raw[:devices][:test2][:ip], 1, 0.2, 1])
+        @ping.expect(:ping?, false, [config.raw[:devices][:roku][:ip], 1, 0.2, 1])
+        @ping.expect(:ping?, true, [config.raw[:devices][:test2][:ip], 1, 0.2, 1])
+        manager = DeviceManager.new(config: config, options: options)
+        device1 = manager.reserve_device
+        assert_raises(DeviceError) do
+          device2 = manager.reserve_device
+        end
+        assert_equal "test2", device1.name
+      end
+    end
+
+    def test_device_manager_reserve_device_specified
+      Net::Ping::External.stub(:new, @ping) do
+        options = {validate: true, device: "test2"}
+        config = good_config(DeviceManagerTest)
+        config[:devices][:test2] = {
+          ip: "192.168.0.101",
+          user: "user",
+          password: "password"
+        }
+        config, options = build_config_options_objects(DeviceManagerTest, options, true, config)
+        @ping.expect(:ping?, true, [config.raw[:devices][:test2][:ip], 1, 0.2, 1])
+        manager = DeviceManager.new(config: config, options: options)
+        device = manager.reserve_device
+        assert_kind_of Device, device
+        assert_equal "test2", device.name
+      end
+    end
+
+    def test_device_manager_reserve_device_blocking
+      Net::Ping::External.stub(:new, FakePing.new) do
+        Thread.abort_on_exception = true
+        options = {validate: true, device_blocking: true}
+        config, options = build_config_options_objects(DeviceManagerTest, options)
+        manager = DeviceManager.new(config: config, options: options)
+        device = manager.reserve_device
+        t = Thread.new do
+          Thread.current[:device] = manager.reserve_device
+        end
+        manager.release_device(device)
+        t.join
+        assert_equal "roku", t[:device].name
+      end
+    end
+
+    def test_device_manager_reserve_device_blocking_timeout
+      Net::Ping::External.stub(:new, FakePing.new) do
+        options = {validate: true, device_blocking: true}
+        config, options = build_config_options_objects(DeviceManagerTest, options)
+        manager = DeviceManager.new(config: config, options: options)
+        manager.instance_variable_set(:@timeout_duration, 0.01)
+        device = manager.reserve_device
+        assert_raises(DeviceError) do
+          puts manager.reserve_device.name
+          puts device.name
+        end
+      end
+    end
+  end
+  class FakePing
+    def initialize(ret: true)
+      @ret = ret
+    end
+    def ping?(*args)
+      @ret
+    end
+  end
+end
+

data/test/roku_builder/test_files/analyzer_test/dont_use_hello_world.json

@@ -0,0 +1,11 @@
+{
+  "is_ssai": true,
+  "rules": [
+    {
+      "regex": "hello world",
+      "case_sensitive": true,
+      "severity": "warning",
+      "message": "dont use hello world"
+    }
+  ]
+}

data/test/roku_builder/test_files/analyzer_test/linter_positive_match.json

@@ -0,0 +1,13 @@
+{
+  "is_ssai": true,
+  "rules": [
+    {
+      "pass_if_match": true,
+      "pass_test_regexp": "hello",
+      "regex": "hello world",
+      "case_sensitive": true,
+      "severity": "warning",
+      "message": "dont use hello world"
+    }
+  ]
+}

data/test/roku_builder/test_helper.rb

@@ -28,6 +28,12 @@ def register_plugins(plugin_class)
     end
   end
 end
+def clean_device_locks(names=["roku"])
+  names.each do |device|
+    path = File.join(Dir.tmpdir, device)
+    File.delete(path) if File.exist?(path)
+  end
+end
 def build_config_options_objects(klass, options = {validate: true}, empty_plugins = true, config_hash = nil)
   options = build_options(options, empty_plugins)
   config = RokuBuilder::Config.new(options: options)

data/test/roku_builder/test_roku_builder.rb

@@ -65,7 +65,7 @@ module RokuBuilder
       RokuBuilder.class_variable_set(:@@plugins, [])
       RokuBuilder.setup_plugins
       register_plugins(Packager)
-      assert_raises DeviceError do
+      assert_raises InvalidOptions do
         RokuBuilder.run(options: {package: true, in: "/in/path", debug: true, config: config})
       end
     end
@@ -79,47 +79,6 @@ module RokuBuilder
       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},
@@ -154,6 +113,10 @@ module RokuBuilder
       assert_equal "b:c", options[:a]
       assert_equal "e:f", options[:d]
     end
+    def test_roku_builder_device_manager
+      manager = RokuBuilder.device_manager
+      assert_kind_of DeviceManager, manager
+    end
     def test_roku_builder_plugins_empty
       RokuBuilder.class_variable_set(:@@plugins, nil)
       RokuBuilder.process_plugins

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roku_builder
 version: !ruby/object:Gem::Version
-  version: 4.25.4
+  version: 4.26.0
 platform: ruby
 authors:
 - greeneca
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-21 00:00:00.000000000 Z
+date: 2022-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -30,14 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: faraday-digestauth
   requirement: !ruby/object:Gem::Requirement
@@ -184,14 +198,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.16'
 - !ruby/object:Gem::Dependency
   name: minitest-autotest
   requirement: !ruby/object:Gem::Requirement
@@ -477,6 +491,7 @@ files:
 - lib/roku_builder/config.rb
 - lib/roku_builder/config_parser.rb
 - lib/roku_builder/config_validator.rb
+- lib/roku_builder/device_manager.rb
 - lib/roku_builder/errors.rb
 - lib/roku_builder/git.rb
 - lib/roku_builder/hash.rb
@@ -526,7 +541,9 @@ files:
 - test/roku_builder/test_config.rb
 - test/roku_builder/test_config_parser.rb
 - test/roku_builder/test_config_validator.rb
+- test/roku_builder/test_device_manager.rb
 - test/roku_builder/test_files/analyzer_test/analyzer_config.json
+- test/roku_builder/test_files/analyzer_test/dont_use_hello_world.json
 - test/roku_builder/test_files/analyzer_test/images/focus.png
 - test/roku_builder/test_files/analyzer_test/images/focus_hd.png
 - test/roku_builder/test_files/analyzer_test/images/focus_sd.png
@@ -534,6 +551,7 @@ files:
 - test/roku_builder/test_files/analyzer_test/images/splash_hd.png
 - test/roku_builder/test_files/analyzer_test/images/splash_sd.png
 - test/roku_builder/test_files/analyzer_test/images/too_small.png
+- test/roku_builder/test_files/analyzer_test/linter_positive_match.json
 - test/roku_builder/test_files/analyzer_test/manifest_depricated_attribute
 - test/roku_builder/test_files/analyzer_test/manifest_duplicate_attribute
 - test/roku_builder/test_files/analyzer_test/manifest_empty_value
@@ -654,7 +672,9 @@ test_files:
 - test/roku_builder/test_config.rb
 - test/roku_builder/test_config_parser.rb
 - test/roku_builder/test_config_validator.rb
+- test/roku_builder/test_device_manager.rb
 - test/roku_builder/test_files/analyzer_test/analyzer_config.json
+- test/roku_builder/test_files/analyzer_test/dont_use_hello_world.json
 - test/roku_builder/test_files/analyzer_test/images/focus.png
 - test/roku_builder/test_files/analyzer_test/images/focus_hd.png
 - test/roku_builder/test_files/analyzer_test/images/focus_sd.png
@@ -662,6 +682,7 @@ test_files:
 - test/roku_builder/test_files/analyzer_test/images/splash_hd.png
 - test/roku_builder/test_files/analyzer_test/images/splash_sd.png
 - test/roku_builder/test_files/analyzer_test/images/too_small.png
+- test/roku_builder/test_files/analyzer_test/linter_positive_match.json
 - test/roku_builder/test_files/analyzer_test/manifest_depricated_attribute
 - test/roku_builder/test_files/analyzer_test/manifest_duplicate_attribute
 - test/roku_builder/test_files/analyzer_test/manifest_empty_value