roku_builder 4.17.1 → 4.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 114ba37cf715600a090d737d83c708b116b2f609c7e261edc235f08c925f0ece
-  data.tar.gz: 2d67e30e939dbe815bccc49be7da543331b78291c6c87c75d2fceaf70cfb7ee6
+  metadata.gz: 478680d7cd38f963d8652c4d359327af7dbb47c2cc5b7552e64bdfd2e82026a9
+  data.tar.gz: de3003e7bff529ed84a84d8c7873da733b50776cf9e531df0d2b9c9bd434a5b6
 SHA512:
-  metadata.gz: 81a51cb1b9af95b7aade298176f544747b08f300eb553b9bd171da5a006fce7f40fd16bf5330e4f8d257da7ea5f97312f7d54eeb6ea3e1fbafc75f0f4eb8f24c
-  data.tar.gz: '0369e150700a626cf96b7651704cf52c581c194562ac41dc8f066a0015c8aa08505f252c81f870dd2a9318e1c0c3613a465b5c45a437ff3607ca840ddb966afe'
+  metadata.gz: ef280481f92632153adb000c66fa6df091b44630d5a35bb73cab4c57b85b8556ef5b620095aa6eca5ced35ef727eea7e085d7bd77658a8134280c3625ef2daa1
+  data.tar.gz: fbc3c21570f154f72276ca7328a26e8d93e430814e59fd897bd3b8aac2faf01e9578d92c32ccdffc66e266e723f636b506421b4db96dcb75e6a029c0d9352d2c

data/.gitignore

@@ -4,3 +4,5 @@ doc
 coverage
 .byebug_history
 Gemfile.lock
+.DS_Store
+**/.DS_Store

data/CHANGELOG

@@ -1,3 +1,7 @@
+ = 4.18.0 =
+
+ - Remove reverse engineered portion of --analyze function, replace with Roku SCA
+
  = 4.17.1 =
 
  - Remove requirement for project default in config

data/lib/roku_builder/os.rb

@@ -0,0 +1,23 @@
+# ********** Copyright 2016 Viacom, Inc. Apache 2.0 **********
+
+module OS
+  def OS.windows?
+    (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM) != nil
+  end
+
+  def OS.mac?
+    (/darwin/ =~ RUBY_PLATFORM) != nil
+  end
+
+  def OS.unix?
+    !OS.windows?
+  end
+
+  def OS.linux?
+    OS.unix? and not OS.mac?
+  end
+
+  def OS.jruby?
+    RUBY_ENGINE == 'jruby'
+  end
+end

data/lib/roku_builder/plugins/analyzer.rb

@@ -30,43 +30,26 @@ module RokuBuilder
     def analyze(options:, quiet: false)
       @options = options
       @warnings = []
-      analyzer_config = get_config("inspector_config.json")
       performance_config = get_config("performance_config.json")
       linter_config = get_config(".roku_builder_linter.json", true)
-      linter_config ||= {}
-      @inspector_config = analyzer_config[:inspectors]
+      linter_config ||= {is_ssai: false}
       loader = Loader.new(config: @config)
       Dir.mktmpdir do |dir|
         loader.copy(options: options, path: dir)
-        raf_inspector = RafInspector.new(config: @config, dir: dir)
-        manifest_inspector = ManifestInspector.new(config: @config, dir: dir, raf: raf_inspector)
-        @warnings.concat(manifest_inspector.run(analyzer_config[:inspectors]))
-        has_source_dir = false
+        run_sca_tool(path: dir, ssai: linter_config[:is_ssai])
         libraries = @config.project[:libraries]
         libraries ||= []
         Dir.glob(File.join(dir, "**", "*")).each do |file_path|
           file = file_path.dup; file.slice!(dir)
           unless libraries.any_is_start?(file) and not @options[:include_libraries]
             if File.file?(file_path) and file_path.end_with?(".brs", ".xml")
-              line_inspector_config = analyzer_config[:lineInspectors]
-              line_inspector_config += performance_config
+              line_inspector_config = performance_config
               line_inspector_config += linter_config[:rules] if linter_config[:rules]
-              line_inspector = LineInspector.new(config: @config, raf: raf_inspector, inspector_config: line_inspector_config, indent_config: linter_config[:indentation])
+              line_inspector = LineInspector.new(inspector_config: line_inspector_config, indent_config: linter_config[:indentation])
               @warnings.concat(line_inspector.run(file_path))
             end
-            if file_path.end_with?("__MACOSX")
-              add_warning(warning: :packageMacosxDirectory, path: file_path)
-            end
-            if file_path.end_with?(".zip", ".md", ".pkg")
-              add_warning(warning: :packageExtraneousFiles, path: file_path)
-            end
           end
-          has_source_dir  = true if file_path.end_with?("source")
-        end
-        unless has_source_dir
-          add_warning(warning: :packageSourceDirectory, path: "source")
         end
-        @warnings.concat(raf_inspector.run(analyzer_config[:inspectors]))
         format_messages(dir)
         print_warnings unless quiet
       end
@@ -75,6 +58,44 @@ module RokuBuilder
 
     private
 
+    def run_sca_tool(path:, ssai:)
+      if OS.unix?
+         command = File.join(File.dirname(__FILE__), "sca-cmd", "bin", "sca-cmd")
+      else
+        command = File.join(File.dirname(__FILE__), "sca-cmd", "bin", "sca-cmd.bat")
+      end
+      results = `#{command} #{path}`.split("\n")
+      process_sca_results(results, ssai)
+    end
+
+    def process_sca_results(results, ssai)
+      results.each do |result_line|
+        if /-----+/.match(result_line) or /\*\*\*\*\*+/.match(result_line)
+          @warnings.push(@sca_warning) if add_warning?(ssai)
+          @sca_warning = {}
+        elsif data = /^(\[WARNING\]|\[INFO\]|\[ERROR\])(.*)$/.match(result_line)
+          @warnings.push(@sca_warning) if add_warning?(ssai)
+          @sca_warning = {}
+          @sca_warning[:severity] = data[1].gsub(/(\[|\])/, "").downcase
+          @sca_warning[:message] = data[2]
+        elsif data = /^\sPath: ([^ ]*) Line: (\d*)./.match(result_line)
+          @sca_warning[:path] = data[1]+":"+data[2]
+        elsif @sca_warning and  @sca_warning[:message]
+          @sca_warning[:message] += " " + result_line
+        end
+      end
+    end
+
+    def add_warning?(ssai)
+      if @sca_warning and @sca_warning[:severity]
+        if ssai and /SetAdUrl\(\) method is missing/.match(@sca_warning[:message])
+          return false
+        end
+        return true
+      end
+      return false
+    end
+
     def get_config(file, project_root=false)
       if project_root
         file = File.join(@config.root_dir, file)
@@ -84,11 +105,6 @@ module RokuBuilder
       JSON.parse(File.open(file).read, {symbolize_names: true}) if File.exist? file
     end
 
-    def add_warning(warning:, path:)
-      @warnings.push(@inspector_config[warning].deep_dup)
-      @warnings.last[:path] = path
-    end
-
     def print_warnings
       logger = ::Logger.new(STDOUT)
       logger.level  = @logger.level

data/lib/roku_builder/plugins/line_inspector.rb

@@ -3,9 +3,7 @@
 module RokuBuilder
 
   class LineInspector
-    def initialize(config:, raf:, inspector_config:, indent_config:)
-      @config = config
-      @raf_inspector = raf
+    def initialize(inspector_config:, indent_config:)
       @inspector_config = inspector_config
       @indent_config = indent_config
     end
@@ -45,7 +43,6 @@ module RokuBuilder
               end
             end
           end
-          @raf_inspector.inspect_line(line: line, file: file_path, line_number: line_number)
         end
         @warnings += indent_inspector.warnings if indent_inspector
       end

data/lib/roku_builder/plugins/sca-cmd/bin/sca-cmd

@@ -0,0 +1,188 @@
+#!/usr/bin/env sh
+
+#
+# Copyright 2015 the original author or authors.
+#
+# 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.
+#
+
+##############################################################################
+##
+##  sca-cmd start up script for UN*X
+##
+##############################################################################
+
+# Attempt to set APP_HOME
+# Resolve links: $0 may be a link
+PRG="$0"
+# Need this for relative symlinks.
+while [ -h "$PRG" ] ; do
+    ls=`ls -ld "$PRG"`
+    link=`expr "$ls" : '.*-> \(.*\)$'`
+    if expr "$link" : '/.*' > /dev/null; then
+        PRG="$link"
+    else
+        PRG=`dirname "$PRG"`"/$link"
+    fi
+done
+SAVED="`pwd`"
+cd "`dirname \"$PRG\"`/.." >/dev/null
+APP_HOME="`pwd -P`"
+cd "$SAVED" >/dev/null
+
+APP_NAME="sca-cmd"
+APP_BASE_NAME=`basename "$0"`
+
+# Add default JVM options here. You can also use JAVA_OPTS and SCA_CMD_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS=""
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD="maximum"
+
+warn () {
+    echo "$*"
+}
+
+die () {
+    echo
+    echo "$*"
+    echo
+    exit 1
+}
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "`uname`" in
+  CYGWIN* )
+    cygwin=true
+    ;;
+  Darwin* )
+    darwin=true
+    ;;
+  MINGW* )
+    msys=true
+    ;;
+  NONSTOP* )
+    nonstop=true
+    ;;
+esac
+
+CLASSPATH=$APP_HOME/lib/sca-cmd.jar
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+        # IBM's JDK on AIX uses strange locations for the executables
+        JAVACMD="$JAVA_HOME/jre/sh/java"
+    else
+        JAVACMD="$JAVA_HOME/bin/java"
+    fi
+    if [ ! -x "$JAVACMD" ] ; then
+        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+else
+    JAVACMD="java"
+    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+fi
+
+# Increase the maximum file descriptors if we can.
+if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
+    MAX_FD_LIMIT=`ulimit -H -n`
+    if [ $? -eq 0 ] ; then
+        if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
+            MAX_FD="$MAX_FD_LIMIT"
+        fi
+        ulimit -n $MAX_FD
+        if [ $? -ne 0 ] ; then
+            warn "Could not set maximum file descriptor limit: $MAX_FD"
+        fi
+    else
+        warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
+    fi
+fi
+
+# For Darwin, add options to specify how the application appears in the dock
+if $darwin; then
+    GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
+fi
+
+# For Cygwin, switch paths to Windows format before running java
+if $cygwin ; then
+    APP_HOME=`cygpath --path --mixed "$APP_HOME"`
+    CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
+    JAVACMD=`cygpath --unix "$JAVACMD"`
+
+    # We build the pattern for arguments to be converted via cygpath
+    ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
+    SEP=""
+    for dir in $ROOTDIRSRAW ; do
+        ROOTDIRS="$ROOTDIRS$SEP$dir"
+        SEP="|"
+    done
+    OURCYGPATTERN="(^($ROOTDIRS))"
+    # Add a user-defined pattern to the cygpath arguments
+    if [ "$GRADLE_CYGPATTERN" != "" ] ; then
+        OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
+    fi
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    i=0
+    for arg in "$@" ; do
+        CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
+        CHECK2=`echo "$arg"|egrep -c "^-"`                                 ### Determine if an option
+
+        if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then                    ### Added a condition
+            eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
+        else
+            eval `echo args$i`="\"$arg\""
+        fi
+        i=$((i+1))
+    done
+    case $i in
+        (0) set -- ;;
+        (1) set -- "$args0" ;;
+        (2) set -- "$args0" "$args1" ;;
+        (3) set -- "$args0" "$args1" "$args2" ;;
+        (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
+        (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
+        (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
+        (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
+        (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
+        (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
+    esac
+fi
+
+# Escape application args
+save () {
+    for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
+    echo " "
+}
+APP_ARGS=$(save "$@")
+
+# Collect all arguments for the java command, following the shell quoting and substitution rules
+eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $SCA_CMD_OPTS -classpath "\"$CLASSPATH\"" com.roku.sca.cmd.CommandLineInterface "$APP_ARGS"
+
+# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
+if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
+  cd "$(dirname "$0")"
+fi
+
+exec "$JAVACMD" "$@"

data/lib/roku_builder/plugins/sca-cmd/bin/sca-cmd.bat

@@ -0,0 +1,100 @@
+@rem
+@rem Copyright 2015 the original author or authors.
+@rem
+@rem Licensed under the Apache License, Version 2.0 (the "License");
+@rem you may not use this file except in compliance with the License.
+@rem You may obtain a copy of the License at
+@rem
+@rem      http://www.apache.org/licenses/LICENSE-2.0
+@rem
+@rem Unless required by applicable law or agreed to in writing, software
+@rem distributed under the License is distributed on an "AS IS" BASIS,
+@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+@rem See the License for the specific language governing permissions and
+@rem limitations under the License.
+@rem
+
+@if "%DEBUG%" == "" @echo off
+@rem ##########################################################################
+@rem
+@rem  sca-cmd startup script for Windows
+@rem
+@rem ##########################################################################
+
+@rem Set local scope for the variables with windows NT shell
+if "%OS%"=="Windows_NT" setlocal
+
+set DIRNAME=%~dp0
+if "%DIRNAME%" == "" set DIRNAME=.
+set APP_BASE_NAME=%~n0
+set APP_HOME=%DIRNAME%..
+
+@rem Add default JVM options here. You can also use JAVA_OPTS and SCA_CMD_OPTS to pass JVM options to this script.
+set DEFAULT_JVM_OPTS=
+
+@rem Find java.exe
+if defined JAVA_HOME goto findJavaFromJavaHome
+
+set JAVA_EXE=java.exe
+%JAVA_EXE% -version >NUL 2>&1
+if "%ERRORLEVEL%" == "0" goto init
+
+echo.
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:findJavaFromJavaHome
+set JAVA_HOME=%JAVA_HOME:"=%
+set JAVA_EXE=%JAVA_HOME%/bin/java.exe
+
+if exist "%JAVA_EXE%" goto init
+
+echo.
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:init
+@rem Get command-line arguments, handling Windows variants
+
+if not "%OS%" == "Windows_NT" goto win9xME_args
+
+:win9xME_args
+@rem Slurp the command line arguments.
+set CMD_LINE_ARGS=
+set _SKIP=2
+
+:win9xME_args_slurp
+if "x%~1" == "x" goto execute
+
+set CMD_LINE_ARGS=%*
+
+:execute
+@rem Setup the command line
+
+set CLASSPATH=%APP_HOME%\lib\sca-cmd.jar
+
+@rem Execute sca-cmd
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %SCA_CMD_OPTS%  -classpath "%CLASSPATH%" com.roku.sca.cmd.CommandLineInterface %CMD_LINE_ARGS%
+
+:end
+@rem End local scope for the variables with windows NT shell
+if "%ERRORLEVEL%"=="0" goto mainEnd
+
+:fail
+rem Set variable SCA_CMD_EXIT_CONSOLE if you need the _script_ return code instead of
+rem the _cmd.exe /c_ return code!
+if  not "" == "%SCA_CMD_EXIT_CONSOLE%" exit 1
+exit /b 1
+
+:mainEnd
+if "%OS%"=="Windows_NT" endlocal
+
+:omega