roku_builder 3.7.3 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: feed4192cc00b8d7f1abb2638fa2c05e6ca9be88
-  data.tar.gz: d84f3a2ede1dd2ef20da90b11bd3c225437e220f
+  metadata.gz: c19396d0acc214911d18c3be499dc2577f1a10de
+  data.tar.gz: 2b0fc5733f711314090aa5d5758f803e105df7af
 SHA512:
-  metadata.gz: 1cf3453ce1d28a1c43c528eb85d3dc83444da9e48a86a1c55880ef4f044939299f10e0b16b2df802a0f0d675b5399b99dc83ca6fc4a19ee93bd7f78ce13a77dd
-  data.tar.gz: b5bbc214dcd936dbe7a6fcf88417f407f46283e0625dc8384e875a36534a60d798aefc85b311c05f4cdf7606f2b7c6c374a2dffa43edb7a75c2f732357de6f01
+  metadata.gz: 3df993d3bee3eb41e489b947fe537d5b3585aac44c2939d9c398d40978b3476079dd11f407e9381fb8598226fec8eaf81be42ebe8d72938bcca8646514ae7ce0
+  data.tar.gz: d92b072dc3d1a6d803bac96d004005c76418f6a390cbd0737899b4c73ad2162a6264c5a794c03ec4ab3eb3d3924485094c84d51907a2c8d6e33d134cbd04f666

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    roku_builder (3.7.3)
+    roku_builder (3.8.0)
       faraday (~> 0.9)
       faraday-digestauth (~> 0.2)
       git (~> 1.3)
       net-ping (~> 1.7)
       net-telnet (~> 0.1)
+      nokogiri (~> 1.6)
       rubyzip (~> 1.2)
 
 GEM
@@ -56,6 +57,7 @@ GEM
       ruby_dep (~> 1.2)
     lumberjack (1.0.10)
     method_source (0.8.2)
+    mini_portile2 (2.1.0)
     minitest (5.9.0)
     minitest-autotest (1.0.3)
       minitest-server (~> 1.0)
@@ -67,9 +69,13 @@ GEM
     net-http-digest_auth (1.4)
     net-ping (1.7.8)
     net-telnet (0.1.1)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
     notiffany (0.1.0)
       nenv (~> 0.1)
       shellany (~> 0.0)
+    pkg-config (1.1.7)
     pry (0.10.3)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)

data/README.md

@@ -19,12 +19,14 @@ development tasks:
  * App Deleteing
  * Package Inspection
  * Monitoring logs
+ * Profile Scene Graph applications
 
-The tool allows scripting of the following interactions with the roku:
+The tool allows scripting of the following:
 
  * Conroller inputs
  * Text Input
  * Screencaptures
+ * Printing project information
 
 Other tasks the tool can complete:
 
@@ -174,11 +176,25 @@ The following are the options to be passed in as type:
  * task2
  * task3
  * taskX
+ * profile
 
 The tool connects to the roku via telnet and prints everything that it
 recieves. It will continue indefinatly unless it is stopped via Ctrl-c or
 entering "q".
 
+#### Profiling Scene Graph
+
+The tool will help a little with profiling scenegraph applications. Running the
+following command will print a list of all of the currently created nodes
+types and how many of each are being created.
+
+    $ roku --profile stats
+
+If you want to see more information about each node you can monitor the
+profile log (See Monitoring Logs above) and enter teh following command:
+
+    $ sgnodes all
+
 #### Testing
 
 There are a few tools that can be used for testing. The testing command will
@@ -302,7 +318,8 @@ directory:
    * Intergration Tests
  * Move RokuBuilder::Controller to RokuBuilder?
  * Allow start and end delimiter for tests to be configured
- * Fix fgile naming when building from a referance
+ * Fix file naming when building from a referance
+ * Extend profiling
 
 ## Contributing
 

data/bin/roku

@@ -72,6 +72,10 @@ OptionParser.new do |opts|
     options[:print] = a
   end
 
+  opts.on("--profile COMMAND", "Command: Run various profiler options") do |c|
+    options[:profile] = c
+  end
+
   opts.on("--do-stage", "Command: Run the stager. Used for scripting. Alwasy run --do-unscript after") do
     options[:dostage] = true
   end

data/lib/roku_builder/config_parser.rb

@@ -228,6 +228,10 @@ module RokuBuilder
       if options[:screen]
         configs[:screen_config] = {type: options[:screen].to_sym}
       end
+      #Create Profiler Config
+      if options[:profile]
+        configs[:profiler_config] = {command: options[:profile].to_sym}
+      end
     end
     private_class_method :setup_simple_configs
   end

data/lib/roku_builder/controller.rb

@@ -166,7 +166,7 @@ module RokuBuilder
     def self.commands
       [:sideload, :package, :test, :deeplink,:configure, :validate, :delete,
         :navigate, :text, :build, :monitor, :update, :screencapture, :key, :screen,
-        :screens, :applist, :print, :dostage, :dounstage]
+        :screens, :applist, :print, :profile, :dostage, :dounstage]
     end
 
     # List of depricated options
@@ -197,7 +197,7 @@ module RokuBuilder
     # @return [Array<Symbol>] List of commands that require a device
     def self.device_commands
       [:sideload, :package, :test, :deeplink, :delete, :navigate, :text,
-        :monitor, :screencapture, :applist, :print ]
+        :monitor, :screencapture, :applist, :print, :profile ]
     end
 
 

data/lib/roku_builder/controller_commands.rb

@@ -23,7 +23,8 @@ module RokuBuilder
         test: { klass: Tester, method: :run_tests, config_key: :test_config },
         screencapture: { klass: Inspector, method: :screencapture, config_key: :screencapture_config,
           failure: FAILED_SCREENCAPTURE },
-        applist: {klass: Linker, method: :list}
+        applist: {klass: Linker, method: :list},
+        profile: {klass: Profiler, method: :run, config_key: :profiler_config}
       }
     end
     # Validate Config
@@ -83,10 +84,16 @@ module RokuBuilder
         # Inspect #
         if options[:inspect]
           info = inspector.inspect(configs[:inspect_config])
-          logger.unknown "App Name: #{info[:app_name]}"
-          logger.unknown "Dev ID: #{info[:dev_id]}"
-          logger.unknown "Creation Date: #{info[:creation_date]}"
-          logger.unknown "dev.zip: #{info[:dev_zip]}"
+          inspect_logger = Logger.new(STDOUT)
+          inspect_logger.formatter = proc {|_severity, _datetime, _progname, msg|
+            "%s\n\r" % [msg]
+          }
+          inspect_logger.unknown "=============================================================="
+          inspect_logger.unknown "App Name: #{info[:app_name]}"
+          inspect_logger.unknown "Dev ID: #{info[:dev_id]}"
+          inspect_logger.unknown "Creation Date: #{info[:creation_date]}"
+          inspect_logger.unknown "dev.zip: #{info[:dev_zip]}"
+          inspect_logger.unknown "=============================================================="
         end
       end
       stager.unstage

data/lib/roku_builder/profiler.rb

@@ -0,0 +1,96 @@
+# ********** Copyright Viacom, Inc. Apache 2.0 **********
+
+module RokuBuilder
+
+  # Scene Graph Profiler
+  class Profiler < Util
+
+    # Run the profiler commands
+    # @param command [Symbol] The profiler command to run
+    def run(command:)
+      case command
+      when :stats
+        print_stats
+      end
+    end
+
+    private
+
+    # Print the node stats
+    def print_stats
+      lines = get_all_nodes
+      xml_string = lines.join("\n")
+      stats = {"Total" => 0}
+      doc = Nokogiri::XML(xml_string)
+      handle_node(stats: stats, node: doc.root)
+      stats = stats.to_a
+      stats = stats.sort {|a, b| b[1] <=> a[1]}
+      printf "%30s | %5s\n", "Name", "Count"
+      stats.each do |key_pair|
+        printf "%30s | %5d\n", key_pair[0], key_pair[1]
+      end
+    end
+
+    def handle_node(stats:,  node:)
+      node.element_children.each do |element|
+        stats[element.name] ||= 0
+        stats[element.name] += 1
+        stats["Total"] += 1
+        handle_node(stats: stats, node: element)
+      end
+    end
+
+    # Retrive list of all nodes
+    # @return [Array<String>] Array of lines
+    def get_all_nodes
+      waitfor_config = {
+        'Match' => /.+/,
+        'Timeout' => 5
+      }
+      telnet_config ={
+        'Host' => @roku_ip_address,
+        'Port' => 8080
+      }
+
+      connection = Net::Telnet.new(telnet_config)
+
+      lines = []
+      all_txt = ""
+      in_nodes = false
+      done = false
+      connection.puts("sgnodes all\n")
+      while not done
+        begin
+          connection.waitfor(waitfor_config) do |txt|
+            in_nodes, done, all_txt = handle_text(all_txt: all_txt, txt: txt, in_nodes: in_nodes, lines: lines)
+          end
+        rescue Net::ReadTimeout
+          @logger.warn "Timed out reading profiler information"
+          done = true
+        end
+      end
+      lines
+    end
+
+    # Handle profiling text
+    # @param all_txt [String] remainder text from last run
+    # @param txt [String] current text from telnet
+    # @param in_nodes [Boolean] currently parsing test text
+    # @return [Boolean] currently parsing test text
+    def handle_text(all_txt:, txt:, in_nodes:, lines:)
+      all_txt += txt
+      end_reg = /<\/All_Nodes>/
+      start_reg = /<All_Nodes>/
+      done = false
+      while line = all_txt.slice!(/^.*\n/) do
+        in_nodes = true if line =~ start_reg
+        lines.push(line) if in_nodes
+        if line =~ end_reg
+          in_nodes = false
+          done = true
+        end
+      end
+      [in_nodes, done, all_txt]
+    end
+  end
+end

data/lib/roku_builder/util.rb

@@ -15,7 +15,8 @@ module RokuBuilder
       @device_config = {
         ip: ip,
         user: user,
-        password: password
+        password: password,
+        logger: logger
       }
       @roku_ip_address = ip
       @dev_username = user

data/lib/roku_builder/version.rb

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

data/lib/roku_builder.rb

@@ -16,6 +16,8 @@ require "git"
 require 'json'
 #stager
 require 'pstore'
+#profiler
+require 'nokogiri'
 
 require "roku_builder/controller"
 require "roku_builder/controller_commands"
@@ -28,6 +30,7 @@ require "roku_builder/packager"
 require "roku_builder/linker"
 require "roku_builder/tester"
 require "roku_builder/scripter"
+require "roku_builder/profiler"
 require "roku_builder/manifest_manager"
 require "roku_builder/config_manager"
 require "roku_builder/config_validator"

data/roku_builder.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "git",                 "~> 1.3"
   spec.add_dependency "net-ping",            "~> 1.7"
   spec.add_dependency "net-telnet",          "~> 0.1"
+  spec.add_dependency "nokogiri",            "~> 1.6"
 
   spec.add_development_dependency "bundler",           "~> 1.7"
   spec.add_development_dependency "rake",              "~> 11.1"

data/tests/roku_builder/config_manager_test.rb

@@ -272,7 +272,7 @@ class ConfigManagerTest < Minitest::Test
     FileUtils.cp(File.join(File.dirname(target_config), "parent_config.json"), target_config)
 
     options = {validate: true, config: target_config, stage: :production}
-    code, config, configs = RokuBuilder::ConfigManager.load_config(options: options, logger: logger)
+    code, config, _configs = RokuBuilder::ConfigManager.load_config(options: options, logger: logger)
     assert_equal RokuBuilder::SUCCESS, code
     assert_equal "app2", config[:projects][:p2][:app_name]
     assert_equal "/dev/null", config[:projects][:p2][:directory]

data/tests/roku_builder/controller_commands_test.rb

@@ -75,7 +75,9 @@ class ControllerCommandsTest < Minitest::Test
         RokuBuilder::Packager.stub(:new, packager) do
           RokuBuilder::Inspector.stub(:new, inspector) do
             RokuBuilder::Stager.stub(:new, stager) do
-              code = RokuBuilder::Controller.send(:execute_commands, {options: options, config: config, configs: configs, logger: logger})
+              Logger.stub(:new, logger) do
+                code = RokuBuilder::Controller.send(:execute_commands, {options: options, config: config, configs: configs, logger: logger})
+              end
             end
           end
         end
@@ -117,7 +119,9 @@ class ControllerCommandsTest < Minitest::Test
         RokuBuilder::Packager.stub(:new, packager) do
           RokuBuilder::Inspector.stub(:new, inspector) do
             RokuBuilder::Stager.stub(:new, stager) do
-              code = RokuBuilder::Controller.send(:execute_commands, {options: options, config: config, configs: configs, logger: logger})
+              Logger.stub(:new, logger) do
+                code = RokuBuilder::Controller.send(:execute_commands, {options: options, config: config, configs: configs, logger: logger})
+              end
             end
           end
         end
@@ -398,7 +402,7 @@ class ControllerCommandsTest < Minitest::Test
     configs = {stage_config: {}}
     code = nil
     scripter_config = {attribute: :title, configs: configs}
-    print_check = lambda {|config| RokuBuilder::SUCCESS if config == scripter_config }
+    print_check = lambda {|print_config| RokuBuilder::SUCCESS if print_config == scripter_config }
     stager.expect(:stage, true)
     stager.expect(:unstage, true)
 

data/tests/roku_builder/profiler_test.rb

@@ -0,0 +1,34 @@
+# ********** Copyright Viacom, Inc. Apache 2.0 **********
+
+require_relative "test_helper.rb"
+
+class ProfilerTest < Minitest::Test
+  def test_profiler_stats
+    waitfor = Proc.new do |config, &blk|
+      assert_equal(/.+/, config["Match"])
+      assert_equal(5, config["Timeout"])
+      txt = "<All_Nodes><NodeA /><NodeB /><NodeC><NodeD /></NodeC></All_Nodes>\n"
+      blk.call(txt)
+      true
+    end
+    connection = Minitest::Mock.new
+    device_config = {
+      ip: "111.222.333",
+      user: "user",
+      password: "password",
+      logger: Logger.new("/dev/null")
+    }
+    profiler = RokuBuilder::Profiler.new(**device_config)
+
+    connection.expect(:puts, nil, ["sgnodes all\n"])
+    connection.expect(:waitfor, nil, &waitfor)
+
+    Net::Telnet.stub(:new, connection) do
+      profiler.stub(:printf, nil) do
+        profiler.run(command: :stats)
+      end
+    end
+
+    connection.verify
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roku_builder
 version: !ruby/object:Gem::Version
-  version: 3.7.3
+  version: 3.8.0
 platform: ruby
 authors:
 - greeneca
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-28 00:00:00.000000000 Z
+date: 2016-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -267,6 +281,7 @@ files:
 - lib/roku_builder/monitor.rb
 - lib/roku_builder/navigator.rb
 - lib/roku_builder/packager.rb
+- lib/roku_builder/profiler.rb
 - lib/roku_builder/scripter.rb
 - lib/roku_builder/stager.rb
 - lib/roku_builder/tester.rb
@@ -288,6 +303,7 @@ files:
 - tests/roku_builder/monitor_test.rb
 - tests/roku_builder/navigator_test.rb
 - tests/roku_builder/packager_test.rb
+- tests/roku_builder/profiler_test.rb
 - tests/roku_builder/scripter_test.rb
 - tests/roku_builder/stager_test.rb
 - tests/roku_builder/test_files/controller_config_test/valid_config.json