standard_automation_library 0.2.1.pre.temp

data/lib/standard_automation_library/services/mobile_tech_debt_logging_service.rb

@@ -0,0 +1,176 @@
+require 'bundler/setup'
+require 'datadog_api_client'
+
+# Sends repo/source file count data to Datadog for modularization tracking:
+# https://app.datadoghq.com/dashboard/pep-25j-j3d/build-mobile-modularization-dashboard
+class MobileTechDebtLoggingService
+  SOURCE = 'build_mobile_tech_debt'.freeze
+  SERVICE = 'build-mobile'.freeze
+
+  # @param [DatadogAPIClient::V2::LogsAPI] logs_client A DotaDog logs API client
+  def initialize(logs_client)
+    @logs_api = logs_client
+    submit_pgf_logs
+    submit_ios_logs
+    submit_android_logs
+  end
+
+  # Generate PGF data and send logs
+  def submit_pgf_logs
+    @pgf_legacy_file_count = Dir.glob('../../pgf/legacy/src/**/*.kt').length
+    @pgf_repositories = Dir.glob('../../pgf/**/*Repository.kt')
+    # For each module in pgf, send log with the module name + total count of .kt files
+    @pgf_folder_paths = Dir.glob('../../pgf/**')
+    @pgf_folder_names = []
+    # Get each module name
+    @pgf_folder_paths.each do |folder_path|
+      next unless File.directory?(folder_path)
+      next if folder_path.include? 'pgf/feature'
+
+      @pgf_folder_names.push(
+        folder_path.slice(folder_path.rindex('/') + 1, folder_path.length)
+      )
+    end
+    # Get file count for each module
+    @pgf_folder_names.each do |name|
+      @pgf_repositories.each do |file_path|
+        next unless file_path.include? "../../pgf/#{name}"
+      end
+      @pgf_file_count = Dir.glob("../../pgf/#{name}/**/*.kt").length
+      _submit_pgf_logs(name, @pgf_file_count)
+    end
+
+    # Repeat for submodules inside feature module
+    # Get each module name inside pgf/feature
+    @pgf_feature_paths = Dir.glob('../../pgf/feature/**')
+    @pgf_feature_folder_names = []
+    @pgf_feature_paths.each do |folder_path|
+      next unless File.directory?(folder_path)
+
+      @pgf_feature_folder_names.push(
+        folder_path.slice(folder_path.rindex('/') + 1, folder_path.length)
+      )
+    end
+    # Get file count for each module
+    @pgf_feature_folder_names.each do |name|
+      @pgf_repositories.each do |file_path|
+        next unless file_path.include? "../../pgf/feature/#{name}"
+      end
+      @pgf_feature_file_count = Dir.glob("../../pgf/feature/#{name}/**/*.kt").length
+      _submit_pgf_logs(name, @pgf_feature_file_count)
+    end
+  end
+
+  # Generate Android data and send logs
+  def submit_android_logs
+    @android_app_module_source_file_count = Dir.glob('../../android/app/src/main/**/*.kt').length +
+                                            Dir.glob('../../android/app/src/main/**/*.java').length
+
+    # Get the name of each submodule inside the Android folder
+    @android_folder_paths = Dir.glob('../../android/**')
+    @android_folder_names = []
+    @android_folder_paths.each do |folder_path|
+      next unless File.directory?(folder_path)
+
+      @android_folder_names.push(
+        folder_path.slice(folder_path.rindex('/') + 1, folder_path.length)
+      )
+    end
+
+    # If submodule contains .kt files, send log with the name + total count of .kt files
+    @android_folder_names.each do |name|
+      @folder_count = Dir.glob("../../android/#{name}/**/*.kt").length
+      next unless @folder_count.positive?
+
+      _submit_android_logs(name, @folder_count)
+    end
+  end
+
+  # Generate iOS data and send logs
+  def submit_ios_logs
+    @ios_source_file_count = Dir.glob('../../ios/PlanGrid/PlanGrid/**/*.swift').length +
+                             Dir.glob('../../ios/PlanGrid/PlanGrid/**/*.m').length
+
+    @ios_project_paths = Dir.glob('../../ios/**')
+    @ios_projects = []
+    @ios_project_paths.each do |path|
+      next unless File.directory?(path)
+
+      @ios_projects.push(
+        path.slice(path.rindex('/') + 1, path.length)
+      )
+    end
+    @ios_default_projects = ['PGSharedTestUtils', 'PlanGrid.xcworkspace', 'Pods', 'scripts', 'fastlane', +
+                              'AlloyComponents', 'jenkins', 'danger']
+
+    @ios_projects.each do |name|
+      next if @ios_default_projects.include? name
+
+      @ios_file_count = Dir.glob("../../ios/#{name}/**/*.swift").length + \
+                        Dir.glob("../../ios/#{name}/**/*.m").length
+      _submit_ios_logs(name, @ios_file_count)
+    end
+  end
+
+  private
+
+  def _submit_pgf_logs(pgf_module_name, pgf_file_count)
+    body = generate_pgf_http_log_items(pgf_module_name, pgf_file_count)
+    p body
+    p @logs_api.submit_log(body)
+  end
+
+  def generate_pgf_http_log_items(pgf_module_name, pgf_file_count)
+    DatadogAPIClient::V2::HTTPLogItem.new(
+      {
+        ddsource: SOURCE,
+        service: SERVICE,
+        build_mobile_tech_debt_pgf_info: {
+          pgf_module: pgf_module_name,
+          pgf_module_file_count: pgf_file_count,
+          pgf_legacy_file_count: @pgf_legacy_file_count
+        }
+      }
+    )
+  end
+
+  def _submit_android_logs(android_module_name, folder_count)
+    body = generate_android_http_log_items(android_module_name, folder_count)
+    p body
+    p @logs_api.submit_log(body)
+  end
+
+  def generate_android_http_log_items(android_module_name, folder_count)
+    DatadogAPIClient::V2::HTTPLogItem.new(
+      {
+        ddsource: SOURCE,
+        service: SERVICE,
+        build_mobile_tech_debt_android_info: {
+          android_module: android_module_name,
+          android_module_file_count: folder_count,
+          android_app_module_source_file_count: @android_app_module_source_file_count
+        }
+      }
+    )
+  end
+
+  def _submit_ios_logs(ios_project_name, ios_file_count)
+    body = generate_ios_http_log_items(ios_project_name, ios_file_count)
+    p body
+    p @logs_api.submit_log(body)
+  end
+
+  def generate_ios_http_log_items(ios_project_name, ios_file_count)
+    DatadogAPIClient::V2::HTTPLogItem.new(
+      {
+        ddsource: SOURCE,
+        service: SERVICE,
+        build_mobile_tech_debt_ios_info: {
+          ios_source_file_count: @ios_source_file_count,
+          ios_project_name: ios_project_name,
+          ios_project_file_count: ios_file_count
+        }
+      }
+    )
+  end
+end

data/lib/standard_automation_library/services/monorepo_platform_service.rb

@@ -0,0 +1,18 @@
+require_relative 'platform_service'
+
+# Abstract class that defines even more methods that
+# a platform service must implement if it is part of the
+# monorepo
+class MonorepoPlatformService < PlatformService
+  def automerge_configuration; end
+
+  def branching_model; end
+
+  def release_manager_team; end
+
+  def released_version; end
+
+  def slack_channels; end
+
+  def version_bump_modification; end
+end

data/lib/standard_automation_library/services/perf_tracker_logging_service.rb

@@ -0,0 +1,87 @@
+require 'bundler/setup'
+require 'datadog_api_client'
+require 'csv'
+
+# Sends perf tracking logs to an analytics service (DataDog).
+# Related Jenkins job: https://c05-acs.jenkins.autodesk.com/job/ACS/job/Custom-Deploy-Tasks/job/Mobile-Common/job/Mobile-Performance-Tracker/
+class PerfTrackerLoggingService
+  VERSION = 0.1
+  SOURCE = 'build_mobile_perf_tracking'.freeze
+  SERVICE = 'Custom-Deploy-Tasks/Build-Mobile-Performance-Tracker'.freeze
+
+  #############################
+  # Sample benchmark.csv file #
+  #############################
+  #
+  # scenario,incremental_build_abi_change_android_app_module,incremental_build_abi_change_pgf_module
+  # version,Gradle 7.5,Gradle 7.5
+  # tasks,assembleAltDebug,:pgf:assembleDebug
+  # value,total execution time,total execution time
+  # warm-up build #1,510100,89209
+  # measured build #1,252134,59647
+  # measured build #2,254684,55937
+
+  SCENARIO        = 0
+  BUILD_SYSTEM    = 1
+  TASKS           = 2
+  VALUE           = 3
+
+  WARM_UP_BUILD   = 'warm-up build #'.freeze
+  MEASURED_BUILD  = 'measured build #'.freeze
+  # TODO: pass this filepath as an argument to this script
+  BENCHMARK_CSV_FILEPATH = '../../profile-out/benchmark.csv'.freeze
+
+  MS_TO_MINS_FACTOR = 1.0 / 1000 / 60
+
+  # @param [DatadogAPIClient::V2::LogsAPI] logs_client A DotaDog logs API client
+  def initialize(logs_client)
+    @logs_api = logs_client
+  end
+
+  def submit_logs
+    _submit_logs(BENCHMARK_CSV_FILEPATH)
+  end
+
+  private
+
+  def _submit_logs(benchmark_filepath)
+    benchmark = CSV.read(benchmark_filepath)
+    body = generate_http_log_items(benchmark)
+    p body
+    p @logs_api.submit_log(body)
+  end
+
+  def generate_http_log_items(benchmark)
+    scenarios = benchmark[SCENARIO]
+    body = []
+    scenarios.each_with_index do |scenario_name, scenario_index|
+      next unless scenario_index.positive?
+
+      num_of_runs = 0
+      running_total_in_ms = 0
+      benchmark.each do |row|
+        if row[0].start_with?(MEASURED_BUILD)
+          num_of_runs += 1
+          running_total_in_ms += row[scenario_index].to_i
+        end
+      end
+      average_time_in_mins = (running_total_in_ms * MS_TO_MINS_FACTOR) / num_of_runs
+      body.push(
+        DatadogAPIClient::V2::HTTPLogItem.new(
+          {
+            ddsource: SOURCE,
+            ddtags: "version:#{VERSION}",
+            service: SERVICE,
+            perf_info: {
+              build_system: benchmark[BUILD_SYSTEM][scenario_index],
+              scenario_name: scenario_name,
+              average_time: average_time_in_mins,
+              tasks: benchmark[TASKS][scenario_index]
+            }
+          }
+        )
+      )
+    end
+    body
+  end
+end

data/lib/standard_automation_library/services/platform_service.rb

@@ -0,0 +1,34 @@
+# Abstract class for a set of common functions
+# each platform needs to implement. Keep
+# alphabetized.
+class PlatformService
+  ORIGIN_REMOTE_NAME = 'origin'.freeze
+
+  def app_version(git_ref = nil); end
+
+  def dry_run?; end
+
+  # absolute path to gemfile
+  def gemfile_path; end
+
+  def platform_name; end
+
+  def release_name(release_identifier)
+    release_identifier
+  end
+
+  def remote_branch(branch_name)
+    "#{remote_repository_name}/#{branch_name}"
+  end
+
+  def remote_repository_name
+    ORIGIN_REMOTE_NAME
+  end
+
+  def repo_name; end
+
+  def update_app_version(new_app_version); end
+
+  # File path is an absolute path
+  def version_file_path; end
+end

data/lib/standard_automation_library/services/repo_service.rb

@@ -0,0 +1,17 @@
+# class for housing repository related information
+class RepositoryService
+  ORIGIN_REMOTE_NAME = 'origin'.freeze
+
+  def initialize(repository_name, remote_repository_name = ORIGIN_REMOTE_NAME)
+    @repository_name = repository_name
+    @remote_repository_name = remote_repository_name
+  end
+
+  def remote_branch(branch_name)
+    "#{remote_repository_name}/#{branch_name}"
+  end
+
+  attr_reader :remote_repository_name
+
+  attr_reader :repository_name
+end