roku_builder 3.13.0 → 4.0.0

data/lib/roku_builder/stager.rb

@@ -5,10 +5,13 @@ module RokuBuilder
   # Change stage of roku application
   class Stager
 
-    def initialize(key: nil, method:, root_dir: nil)
-      @method = method
-      @key = key
-      @root_dir = root_dir
+    def initialize(config:, options:)
+      @config = config
+      @options = options
+      @method = get_method
+      @ref = get_git_ref
+      @scripts = get_scripts
+      @root_dir = config.root_dir
       @logger = Logger.instance
       @stage_success = true
       @stash_key = "roku-builder-temp-stash"
@@ -25,19 +28,22 @@ module RokuBuilder
     # @return [Boolean] whether the staging was successful or not
     def stage
       @orginal_directory = Dir.pwd
-      Dir.chdir(@root_dir) unless @root_dir.nil? or @root_dir == @orginal_directory
       case @method
-      when :current, :in, :working
+      when :current, :in
         # Do Nothing
+      when :working
+        switch_directory
       when :git
+        switch_directory
         begin
-          git_switch_to(branch: @key)
+          git_switch_to(branch: @ref)
         rescue Git::GitExecuteError
           git_rescue
           @stage_success = false
         end
       when :script
-        Controller.system(command: @key[:stage])
+        switch_directory
+        RokuBuilder.system(command: @scripts[:stage])
       end
       @stage_success
     end
@@ -46,27 +52,57 @@ module RokuBuilder
     # @return [Boolean] whether the revert was successful or not
     def unstage
       @orginal_directory ||= Dir.pwd
-      Dir.chdir(@root_dir) unless @root_dir.nil? or @root_dir == @orginal_directory
       unstage_success = true
       case @method
       when :current, :in, :working
         # Do Nothing
       when :git
+        switch_directory
         begin
-          git_switch_from(branch: @key, checkout: @stage_success)
+          git_switch_from(branch: @ref, checkout: @stage_success)
         rescue Git::GitExecuteError
           git_rescue
           unstage_success = false
         end
+        switch_directory_back
       when :script
-        Controller.system(command: @key[:unstage])  if @key[:unstage]
+        switch_directory
+        RokuBuilder.system(command: @scripts[:unstage])  if @scripts[:unstage]
+        switch_directory_back
       end
-      Dir.chdir(@orginal_directory) unless @root_dir == @orginal_directory
       unstage_success
     end
 
     private
 
+    def get_method
+      method = ([:in, :current, :working] & @options.keys).first
+      if @config.project
+        method = @config.project[:stage_method]
+      end
+      method
+    end
+
+    def get_git_ref
+      if @options[:ref]
+        @options[:ref]
+      elsif @config.stage
+        @config.stage[:branch]
+      end
+    end
+
+    def get_scripts
+      @config.stage[:script] if @config.stage
+    end
+
+    def switch_directory
+      Dir.chdir(@root_dir) unless @root_dir.nil? or @root_dir == @orginal_directory
+    end
+
+    def switch_directory_back
+      Dir.chdir(@orginal_directory) unless @root_dir == @orginal_directory
+    end
+
     # Switch to the correct branch
     # @param branch [String] the branch to switch to
     def git_switch_to(branch:)

data/lib/roku_builder/string.rb

@@ -0,0 +1,20 @@
+# ********** Copyright 2016 Viacom, Inc. Apache 2.0 **********
+
+class ::String
+  def underscore!
+    word = self
+    word.gsub!(/::/, '/')
+    word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+    word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+    word.tr!("-", "_")
+    word.downcase!
+    nil
+  end
+
+  def underscore
+    word = self.dup
+    word.underscore!
+    word
+  end
+end
+

data/lib/roku_builder/util.rb

@@ -1,34 +1,25 @@
 # ********** Copyright Viacom, Inc. Apache 2.0 **********
-
 module RokuBuilder
 
-  # Super class for device utilities
+  # Super class for modules
   # This class defines a common initializer and allows subclasses
   # to define their own secondary initializer
   class Util
 
     # Common initializer of device utils
-    # @param ip [String] IP address of roku device
-    # @param user [String] Username for roku device
-    # @param password [String] Password for roku device
-    def initialize(ip:, user:, password:, init_params: nil)
+    # @param config [Config] Configuration object for the app
+    def initialize(config: )
       @logger = Logger.instance
-      @device_config = {
-        ip: ip,
-        user: user,
-        password: password
-      }
-      @roku_ip_address = ip
-      @dev_username = user
-      @dev_password = password
+      @config = config
+      @roku_ip_address = @config.device_config[:ip]
+      @dev_username = @config.device_config[:user]
+      @dev_password = @config.device_config[:password]
       @url = "http://#{@roku_ip_address}"
-      if init_params
-        init(**init_params)
-      else
-        init
-      end
+      init
     end
 
+    private
+
     # Second initializer to be overwriten
     def init
       #Override in subclass
@@ -57,20 +48,5 @@ module RokuBuilder
         f.adapter Faraday.default_adapter
       end
     end
-
-    # Parses a string into and options hash
-    # @param options [String] string of options in the format "a:b, c:d"
-    # @return [Hash] Options hash generated
-    def self.options_parse(options:)
-      parsed = {}
-      opts = options.split(/,\s*/)
-      opts.each do |opt|
-        opt = opt.split(":")
-        key = opt.shift.to_sym
-        value = opt.join(":")
-        parsed[key] = value
-      end
-      parsed
-    end
   end
 end

data/lib/roku_builder/version.rb

@@ -2,5 +2,5 @@
 
 module RokuBuilder
   # Version of the RokuBuilder Gem
-  VERSION = "3.13.0"
+  VERSION = "4.0.0"
 end

data/rakefile

@@ -4,7 +4,11 @@ require 'rake'
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
-    t.test_files = Dir.glob('test/roku_builder/test_*.rb')
+  t.test_files = Dir.glob('test/roku_builder/**/test_*.rb')
+end
+
+Rake::TestTask.new(:intergration) do |t|
+  t.test_files = Dir.glob('intergration/roku_builder/**/test_*.rb')
 end
 
 task(default: :test)

data/roku_builder.gemspec

@@ -35,6 +35,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest",          "~> 5.10"
   spec.add_development_dependency "minitest-autotest", "~> 1.0"
   spec.add_development_dependency "minitest-server",   "~> 1.0"
+  spec.add_development_dependency "minitest-utils",    "~> 0.3"
+  spec.add_development_dependency "webmock",           "~> 3.0"
   spec.add_development_dependency "simplecov",         "~> 0.12"
   spec.add_development_dependency "coveralls",         "~> 0.8"
   spec.add_development_dependency "yard",              "~> 0.9"

data/test/roku_builder/plugins/test_core.rb

@@ -0,0 +1,112 @@
+# ********** Copyright Viacom, Inc. Apache 2.0 **********
+
+require_relative "../test_helper.rb"
+
+module RokuBuilder
+  class CoreTest < Minitest::Test
+    def setup
+      Logger.set_testing
+      RokuBuilder.setup_plugins
+      register_plugins(Core)
+    end
+    def test_core_parse_options_long
+      parser = OptionParser.new
+      options = {}
+      Core.parse_options(parser: parser, options: options)
+      argv = ["roku", "--configure", "--validate", "--update-manifest", "--do-stage",
+        "--do-unstage", "--edit", "params", "--config", "config-path",
+        "--ref", "ref", "--working", "--current", "--stage", "stage", "--project",
+        "project", "--out", "out", "--in", "in", "--device", "device",
+        "--verbose", "--debug"]
+      parser.parse! argv
+      assert options[:configure]
+      assert options[:validate]
+      assert options[:increment]
+      assert options[:dostage]
+      assert options[:dounstage]
+      assert_equal "params", options[:edit_params]
+      assert_equal "config-path", options[:config]
+      assert_equal "ref", options[:ref]
+      assert options[:working]
+      assert options[:current]
+      assert_equal "stage", options[:stage]
+      assert_equal "project", options[:project]
+      assert_equal "out", options[:out]
+      assert_equal "in", options[:in]
+      assert_equal "device", options[:device]
+      assert options[:device_given]
+      assert options[:verbose]
+      assert options[:debug]
+    end
+    def test_core_parse_options_short
+      parser = OptionParser.new
+      options = {}
+      Core.parse_options(parser: parser, options: options)
+      argv = ["roku", "-u", "-e", "params", "-r", "ref", "-w", "-c", "-s",
+        "stage", "-p", "project",  "-O", "out", "-I", "in", "-D", "device", "-V"]
+      parser.parse! argv
+      assert options[:increment]
+      assert_equal "params", options[:edit_params]
+      assert_equal "ref", options[:ref]
+      assert options[:working]
+      assert options[:current]
+      assert_equal "stage", options[:stage]
+      assert_equal "project", options[:project]
+      assert_equal "out", options[:out]
+      assert_equal "in", options[:in]
+      assert_equal "device", options[:device]
+      assert options[:device_given]
+      assert options[:verbose]
+    end
+    def test_core_configure
+      logger = Minitest::Mock.new
+      options = {configure: true, config: File.join(test_files_path(CoreTest), "config.json")}
+      config, options = build_config_options_objects(CoreTest, options, false)
+      logger.expect(:unknown, nil, ["Configured"])
+      Logger.class_variable_set(:@@instance, logger)
+      core = Core.new(config: config)
+      core.configure(options: options)
+      logger.verify
+    end
+    def test_core_validate
+      logger = Minitest::Mock.new
+      config, options = build_config_options_objects(CoreTest, {validate: true}, false)
+      logger.expect(:unknown, nil, ["Config Validated"])
+      Logger.class_variable_set(:@@instance, logger)
+      core = Core.new(config: config)
+      core.validate(options: options)
+      logger.verify
+    end
+    def test_core_increment
+      config, options = build_config_options_objects(CoreTest, {increment: true, working: true}, false)
+      source = File.join(test_files_path(CoreTest), "manifest_template")
+      target = File.join(test_files_path(CoreTest), "manifest")
+      FileUtils.cp(source, target)
+      core = Core.new(config: config)
+      Time.stub(:now, Time.new(2001, 02, 01)) do
+        core.increment(options: options)
+      end
+      assert_equal "020101.2", Manifest.new(config: config).build_version
+      FileUtils.rm(target)
+    end
+    def test_core_dostage
+      stager = Minitest::Mock.new
+      config, options = build_config_options_objects(CoreTest, {increment: true, working: true}, false)
+      stager.expect(:stage, nil)
+      core = Core.new(config: config)
+      Stager.stub(:new, stager) do
+        core.dostage(options: options)
+      end
+    end
+    def test_core_dounstage
+      stager = Minitest::Mock.new
+      config, options = build_config_options_objects(CoreTest, {increment: true, working: true}, false)
+      stager.expect(:unstage, nil)
+      core = Core.new(config: config)
+      Stager.stub(:new, stager) do
+        core.dounstage(options: options)
+      end
+    end
+  end
+end
+

data/test/roku_builder/plugins/test_inspector.rb

@@ -0,0 +1,165 @@
+# ********** Copyright Viacom, Inc. Apache 2.0 **********
+
+require_relative "../test_helper.rb"
+module RokuBuilder
+  class InspectorTest < Minitest::Test
+    def setup
+      Logger.set_testing
+      RokuBuilder.setup_plugins
+      register_plugins(Inspector)
+      @requests = []
+    end
+    def teardown
+      @requests.each {|req| remove_request_stub(req)}
+    end
+    def test_inspector_parse_options_long
+      parser = OptionParser.new
+      options = {}
+      Inspector.parse_options(parser: parser, options: options)
+      argv = ["roku", "--inspect", "--screencapture", "--password", "password"]
+      parser.parse! argv
+      assert options[:inspect]
+      assert options[:screencapture]
+      assert_equal "password", options[:password]
+    end
+    def test_scripter_parse_options_short
+      parser = OptionParser.new
+      options = {}
+      Inspector.parse_options(parser: parser, options: options)
+      argv = ["roku", "-S"]
+      parser.parse! argv
+      assert options[:screencapture]
+    end
+    def test_inspector_inspect
+      logger = Minitest::Mock.new()
+
+      logger.expect(:formatter=, nil, [Proc])
+      logger.expect(:unknown, nil){|text| /=*/ =~ text}
+      logger.expect(:unknown, nil){|text| /app_name/ =~ text}
+      logger.expect(:unknown, nil){|text| /dev_id/ =~ text}
+      logger.expect(:unknown, nil, [String])
+      logger.expect(:unknown, nil){|text| /dev_zip/ =~ text}
+      logger.expect(:unknown, nil){|text| /=*/ =~ text}
+
+      body = "r1.insertCell(0).innerHTML = 'App Name: ';"+
+        "      r1.insertCell(1).innerHTML = '<div class=\"roku-color-c3\">app_name</div>';"+
+        ""+
+        "      var r2 = table.insertRow(1);"+
+        "      r2.insertCell(0).innerHTML = 'Dev ID: ';"+
+        "      r2.insertCell(1).innerHTML = '<div class=\"roku-color-c3\"><font face=\"Courier\">dev_id</font></div>';"+
+        "      "+
+        "      var dd = new Date(628232400);"+
+        "      var ddStr = \"\";"+
+        "      ddStr += (dd.getMonth()+1);"+
+        "      ddStr += \"/\";"+
+        "      ddStr += dd.getDate();"+
+        "      ddStr += \"/\";"+
+        "      ddStr += dd.getFullYear();"+
+        "      ddStr += \" \";"+
+        "      ddStr += dd.getHours();"+
+        "      ddStr += \":\";"+
+        "      ddStr += dd.getMinutes();"+
+        "      ddStr += \":\";"+
+        "      ddStr += dd.getSeconds(); "+
+        "      "+
+        "      var r3 = table.insertRow(2);"+
+        "      r3.insertCell(0).innerHTML = 'Creation Date: ';"+
+        "      r3.insertCell(1).innerHTML = '<div class=\"roku-color-c3\">'+ddStr+'</div>';"+
+        "      "+
+        "      var r4 = table.insertRow(3);"+
+        "      r4.insertCell(0).innerHTML = 'dev.zip: ';"+
+        "      r4.insertCell(1).innerHTML = '<div class=\"roku-color-c3\"><font face=\"Courier\">dev_zip</font></div>';"
+
+      @requests.push(stub_request(:post, "http://192.168.0.100/plugin_inspect").
+        to_return(status: 200, body: body, headers: {}))
+
+      options = {inspect: true, in: File.join(test_files_path(InspectorTest), "test.pkg"), password: "password"}
+      config, options = build_config_options_objects(InspectorTest, options, false)
+      inspector = Inspector.new(config: config)
+      ::Logger.stub(:new, logger) do
+        inspector.inspect(options: options)
+      end
+    end
+    def test_inspector_inspect_old_interface
+      logger = Minitest::Mock.new()
+
+      logger.expect(:formatter=, nil, [Proc])
+      logger.expect(:unknown, nil){|text| /=*/ =~ text}
+      logger.expect(:unknown, nil){|text| /app_name/ =~ text}
+      logger.expect(:unknown, nil){|text| /dev_id/ =~ text}
+      logger.expect(:unknown, nil, [String])
+      logger.expect(:unknown, nil){|text| /dev_zip/ =~ text}
+      logger.expect(:unknown, nil){|text| /=*/ =~ text}
+      body = " <table cellpadding=\"2\">"+
+        " <tbody><tr><td> App Name: </td><td> <font color=\"blue\">app_name</font> </td></tr>"+
+        " <tr><td> Dev ID: </td><td> <font face=\"Courier\" color=\"blue\">dev_id</font> </td></tr>"+
+        " <tr><td> Creation Date: </td><td> <font color=\"blue\">"+
+        " <script type=\"text/javascript\">"+
+        " var d = new Date(628232400)"+
+        " document.write(d.getMonth()+1)"+
+        " document.write(\"/\")"+
+        " document.write(d.getDate())"+
+        " document.write(\"/\");"+
+        " document.write(d.getFullYear())"+
+        " document.write(\" \")"+
+        " document.write(d.getHours())"+
+        " document.write(\":\")"+
+        " document.write(d.getMinutes())"+
+        " document.write(\":\")"+
+        " document.write(d.getSeconds())"+
+        " </script>1/17/1970 16:42:28"+
+        " </font> </td></tr>"+
+        " <tr><td> dev.zip: </td><td> <font face=\"Courier\" color=\"blue\">dev_zip</font> </td></tr>"+
+        " </tbody></table>"
+
+      @requests.push(stub_request(:post, "http://192.168.0.100/plugin_inspect").
+        to_return(status: 200, body: body, headers: {}))
+
+      options = {inspect: true, in: File.join(test_files_path(InspectorTest), "test.pkg"), password: "password"}
+      config, options = build_config_options_objects(InspectorTest, options, false)
+      inspector = Inspector.new(config: config)
+      ::Logger.stub(:new, logger) do
+        inspector.inspect(options: options)
+      end
+    end
+
+    def test_screencapture
+      body = "<hr /><img src=\"pkgs/dev.jpg?time=1455629573\">"
+      @requests.push(stub_request(:post, "http://192.168.0.100/plugin_inspect").
+        to_return(status: 200, body: body, headers: {}))
+
+      body2 = "<screencapture>"
+      @requests.push(stub_request(:get, "http://192.168.0.100/pkgs/dev.jpg?time=1455629573").
+        to_return(status: 200, body: body2, headers: {}))
+
+      io = Minitest::Mock.new()
+      io.expect("write", nil, [body2])
+
+      options = {screencapture: true }
+      config, options = build_config_options_objects(InspectorTest, options, false)
+      inspector = Inspector.new(config: config)
+      File.stub(:open, nil, io) do
+        inspector.screencapture(options: options)
+      end
+    end
+    def test_screencapture_png
+      body = "<hr /><img src=\"pkgs/dev.png?time=1455629573\">"
+      @requests.push(stub_request(:post, "http://192.168.0.100/plugin_inspect").
+        to_return(status: 200, body: body, headers: {}))
+
+      body2 = "<screencapture>"
+      @requests.push(stub_request(:get, "http://192.168.0.100/pkgs/dev.png?time=1455629573").
+        to_return(status: 200, body: body2, headers: {}))
+
+      io = Minitest::Mock.new()
+      io.expect("write", nil, [body2])
+
+      options = {screencapture: true }
+      config, options = build_config_options_objects(InspectorTest, options, false)
+      inspector = Inspector.new(config: config)
+      File.stub(:open, nil, io) do
+        inspector.screencapture(options: options)
+      end
+    end
+  end
+end