Split check command into separate file (#9707)

This commit is contained in:
Maximilian Downey Twiss
2025-03-04 09:22:49 +11:00
committed by GitHub
parent b062c58c21
commit 7e9c6804ce
8 changed files with 91 additions and 80 deletions

63
commands/check.rb Normal file
View File

@@ -0,0 +1,63 @@
require 'fileutils'
require_relative '../lib/const'
require_relative '../lib/package'
require_relative '../lib/package_utils'
class Command
def self.check(name, force)
local_package = File.join(CREW_LOCAL_REPO_ROOT, 'packages', "#{name}.rb")
crew_package = File.join(CREW_PACKAGES_PATH, "#{name}.rb")
# We return true here in order to exit early but behave as if the check passed, so that other operations can continue.
unless File.file?(local_package)
# If the operation is a bare 'crew check', then we don't want to silently skip it.
puts 'No local package file found, skipping check.'.lightred if caller_locations(1, 2)[0].to_s.split[3].split('_')[0].split('#')[1].to_s == 'check'
return true
end
# Use rubocop to sanitize package file, and let errors get flagged.
if PackageUtils.installed?('ruby_rubocop')
puts "Using rubocop to sanitize #{local_package}".orange
system "rubocop -c #{File.join(CREW_LOCAL_REPO_ROOT, '.rubocop.yml')} -A #{local_package}", exception: true
else
puts "Rubocop is not installed, and thus will not be used to sanitize #{local_package}".lightred
puts 'To install Rubocop, run the following command: '.lightred + 'crew install ruby_rubocop'.lightblue
end
to_copy = force
# Prompt to copy the local repo package to crew if the package is not found.
unless force || File.file?(crew_package)
puts "The crew package '#{name}' does not exist."
to_copy = true
end
# Compare local repo package to the crew repo package and prompt to copy if necessary to prepare for the operation.
unless force || (File.file?(crew_package) && FileUtils.identical?(local_package, crew_package))
puts "#{CREW_LOCAL_REPO_ROOT}/packages/#{name}.rb does not match the crew package."
to_copy = true
end
if to_copy && !force
# This pulls the operation from the calling function.
operation = caller_locations(1, 2)[0].to_s.split[3].split('_')[0].split('#')[1]
if Package.agree_default_yes("\nWould you like to copy #{name}.rb to crew and start the #{operation}")
to_copy = true
else
return false
end
end
if to_copy
FileUtils.copy_file(local_package, crew_package)
puts "Copied #{local_package} to #{CREW_PACKAGES_PATH}".lightgreen
end
# Run property and buildsystem tests on the package, and fail if they fail.
return false unless system "#{CREW_LIB_PATH}/tests/prop_test #{name}"
return false unless system "#{CREW_LIB_PATH}/tests/buildsystem_test #{name}"
# If we're still here every test has passed, so return true.
return true
end
end

View File

@@ -15,10 +15,10 @@ class Command
EOT
when 'check'
puts <<~EOT
Check package(s) for syntax errors and upstream updates.
Usage: crew check [-V|--version] [-v|--verbose] <package1> [<package2> ...]
If `-V` or `--version` is present, it will search for an upstream update.
If `-v` or `--verbose` is present, up to date packages will be displayed.
Check package(s) for syntax errors, and copy local packages to the chromebrew directory.
Usage: crew check [-f|--force] <package1> [<package2> ...]
Local packages will be copied to the chromebrew directory if they do not exist there, or if they are different to the chromebrew package files.
If `-f` or `--force` is present, packages will be copied without question.
EOT
when 'const'
puts <<~EOT