diff options
Diffstat (limited to 'scripts/analysis/lint-up.rb')
| -rw-r--r-- | scripts/analysis/lint-up.rb | 199 |
1 files changed, 199 insertions, 0 deletions
diff --git a/scripts/analysis/lint-up.rb b/scripts/analysis/lint-up.rb new file mode 100644 index 000000000..ad8c8b81c --- /dev/null +++ b/scripts/analysis/lint-up.rb @@ -0,0 +1,199 @@ +## Script from https://github.com/tir38/android-lint-entropy-reducer at 07.05.2017 +# adapts to drone, use git username / token as parameter + +Encoding.default_external = Encoding::UTF_8 +Encoding.default_internal = Encoding::UTF_8 + +puts "=================== starting Android Lint Entropy Reducer ====================" + +# get args +git_user, git_token, git_branch = ARGV + +# ======================== SETUP ============================ + +# User name for git commits made by this script. +TRAVIS_GIT_USERNAME = String.new("Drone CI server") + +# File name and relative path of generated Lint report. Must match build.gradle file: +# lintOptions { +# htmlOutput file("[FILE_NAME].html") +# } +LINT_REPORT_FILE = String.new("app/build/reports/lint/lint.html") + +# File name and relative path of previous results of this script. +PREVIOUS_LINT_RESULTS_FILE=String.new("scripts/analysis/lint-results.txt") + +# Flag to evaluate warnings. true = check warnings; false = ignore warnings +CHECK_WARNINGS = true + +# File name and relative path to custom lint rules; Can be null or "". +CUSTOM_LINT_FILE = String.new("") + +# ================ SETUP DONE; DON'T TOUCH ANYTHING BELOW ================ + +require 'fileutils' +require 'pathname' +require 'open3' + +# since we need the xml-simple gem, and we want this script self-contained, let's grab it just when we need it +begin + gem "xml-simple" + rescue LoadError + system("gem install xml-simple") + Gem.clear_paths +end + +require 'xmlsimple' + +# add custom Lint jar +if !CUSTOM_LINT_FILE.nil? && + CUSTOM_LINT_FILE.length > 0 + + ENV["ANDROID_LINT_JARS"] = Dir.pwd + "/" + CUSTOM_LINT_FILE + puts "adding custom lint rules to default set: " + puts ENV["ANDROID_LINT_JARS"] +end + +# run Lint +puts "running Lint..." +system './gradlew clean assemble lint' + +# confirm that Lint ran w/out error +result = $?.to_i +if result != 0 + puts "FAIL: failed to run ./gradlew clean assembleGplay lint" + exit 1 +end + +# find Lint report file +lint_reports = Dir.glob(LINT_REPORT_FILE) +if lint_reports.length == 0 + puts "Lint HTML report not found." + exit 1 +end +lint_report = String.new(lint_reports[0]) + +# find error/warning count string in HTML report +error_warning_string = "" +File.open lint_report do |file| + error_warning_string = file.find { |line| line =~ /([0-9]* error[s]? and )?[0-9]* warning[s]?/ } +end + +# find number of errors +error_string = error_warning_string.match(/[0-9]* error[s]?/) + +if (error_string.nil?) + current_error_count = 0 +else + current_error_count = error_string[0].match(/[0-9]*/)[0].to_i +end + +puts "found errors: " + current_error_count.to_s + +# find number of warnings +if CHECK_WARNINGS == true + warning_string = error_warning_string.match(/[0-9]* warning[s]?/)[0] + current_warning_count = warning_string.match(/[0-9]*/)[0].to_i + puts "found warnings: " + current_warning_count.to_s +end + +# get previous error and warning counts from last successful build + +previous_results = false + +previous_lint_reports = Dir.glob(PREVIOUS_LINT_RESULTS_FILE) +if previous_lint_reports.nil? || + previous_lint_reports.length == 0 + + previous_lint_report = File.new(PREVIOUS_LINT_RESULTS_FILE, "w") # create for writing to later +else + previous_lint_report = String.new(previous_lint_reports[0]) + + previous_error_warning_string = "" + File.open previous_lint_report do |file| + previous_error_warning_string = file.find { |line| line =~ /([0-9]* error[s]? and )?[0-9]* warning[s]?/ } + end + + unless previous_error_warning_string.nil? + previous_results = true + + previous_error_string = previous_error_warning_string.match(/[0-9]* error[s]?/) + if previous_error_string.nil? + previous_error_string = "0 errors" + else + previous_error_string = previous_error_string[0] + end + previous_error_count = previous_error_string.match(/[0-9]*/)[0].to_i + puts "previous errors: " + previous_error_count.to_s + + if CHECK_WARNINGS == true + previous_warning_string = previous_error_warning_string.match(/[0-9]* warning[s]?/) + if previous_warning_string.nil? + previous_warning_string = "0 warnings" + else + previous_warning_string = previous_warning_string[0] + end + previous_warning_count = previous_warning_string.match(/[0-9]*/)[0].to_i + puts "previous warnings: " + previous_warning_count.to_s + end + end +end + +# compare previous error count with current error count +if previous_results == true && + current_error_count > previous_error_count + puts "FAIL: error count increased" + exit 1 +end + +# compare previous warning count with current warning count +if CHECK_WARNINGS == true && + previous_results == true && + current_warning_count > previous_warning_count + + puts "FAIL: warning count increased" + exit 1 +end + +# check if warning and error count stayed the same +if previous_results == true && + current_error_count == previous_error_count && + current_warning_count == previous_warning_count + + puts "SUCCESS: count stayed the same" + exit 2 +end + +# either error count or warning count DECREASED + +# write new results to file (will overwrite existing, or create new) +File.write(previous_lint_report, "DO NOT TOUCH; GENERATED BY DRONE\n" + error_warning_string) + +# push changes to github (if this script is run locally, we don't want to overwrite git username and email, so save temporarily) +previous_git_username, _ = Open3.capture2('git config user.name') +previous_git_username = previous_git_username.strip + +previous_git_email, _ = Open3.capture3('git config user.email') +previous_git_email = previous_git_email.strip + +# update git user name and email for this script +system ("git config --local user.name '" + git_user + "'") +system ("git config --local user.email '.'") # set email blank +system ("git remote rm origin") +system ("git remote add origin https://" + git_user + ":" + git_token + "@github.com/nextcloud/talk-android") + +# add previous Lint result file to git +system ('git add ' + PREVIOUS_LINT_RESULTS_FILE) + +# commit changes; Add "skip ci" so that we don't accidentally trigger another Drone build +system ('git commit -m "Drone: update Lint results to reflect reduced error/warning count [skip ci]" ') + +# push to origin +system ('git push origin HEAD:' + git_branch) + +# restore previous git user name and email +system("git config --local user.name '#{previous_git_username}'") +system("git config --local user.email '#{previous_git_email}'") + +puts "SUCCESS: count was reduced" +exit 0 # success |