github/chromebrew
1
1
Fork 0
mirror of https://github.com/chromebrew/chromebrew.git synced 2026-01-08 23:18:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

Split out help command to separate file (#9392)

Browse Source
This commit is contained in:
Maximilian Downey Twiss
2024-02-27 09:21:11 +11:00
committed by GitHub
parent 6c8f62654f
commit 925a461efb
7 changed files with 255 additions and 210 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.github/workflows/Unit-Test.yml vendored
View File

@@ -22,6 +22,7 @@ jobs:
yes | crew remove vim && \
cd ../tests && \
./prop_test && \
ruby commands/* && \
cd ~ && \
git clone --depth=1 https://github.com/chromebrew/chromebrew.git build_test && \
cd build_test && \

211
bin/crew
View File

@@ -4,6 +4,7 @@ require 'digest/sha2'
require 'json'
require 'fileutils'
require 'tmpdir'
require_relative '../commands/help'
require_relative '../lib/docopt'
require_relative '../lib/color'
require_relative '../lib/const'
@@ -340,207 +341,6 @@ def regexp_search(pkgPat)
abort "Package #{pkgPat} not found. :(".lightred if results.empty?
end
def help(pkgName = nil)
case pkgName
when 'build'
puts <<~EOT
Build package(s).
Usage: crew build [-k|--keep] [-v|--verbose] <package1> [<package2> ...]
Build package(s) from source and place the archive and checksum in the `CREW_LOCAL_BUILD_DIR/release/<arch>` directory.
If `-f` or `--force` is present, the `CREW_LOCAL_BUILD_DIR/release/<arch>` directories will be created.
If `-k` or `--keep` is present, the `CREW_BREW_DIR` (#{CREW_BREW_DIR}) directory will remain.
If `-v` or `--verbose` is present, extra information will be displayed.
EOT
when 'const'
puts <<~EOT
Display constant(s).
Usage: crew const [<const1> <const2> ...]
If no constants are provided, all constants will be displayed.
EOT
when 'deps'
puts <<~EOT
Display dependencies of package(s).
Usage: crew deps [--deep] [-t|--tree] [-b|--include-build-deps] [--exclude-buildessential] <package1> [<package2> ...]
If `--deep` specified, runtime dependencies will be generated by crawling every binary in a package.
If `-t` or `--tree` specified, dependencies will be printed in a tree-structure format.
If `-b` or `--include-build-deps` specified, build dependencies will be included in output.
It `--exclude-buildessential` specified, `buildessential` and its dependencies will not be inserted automatically.
EOT
when 'download'
puts <<~EOT
Download package(s).
Usage: crew download [-s|--source] [-v|--verbose] <package1> [<package2> ...]
Download package(s) to `CREW_BREW_DIR` (#{CREW_BREW_DIR}), but don't install.
If `-s` or `--source` is present, the source will be downloaded instead of the binary.
If `-v` or `--verbose` is present, extra information will be displayed.
EOT
when 'files'
puts <<~EOT
Display installed files of package(s).
Usage: crew files <package1> [<package2> ...]
The package(s) must be currently installed.
EOT
when 'install'
puts <<~EOT
Install package(s).
Usage: crew install [-k|--keep] [-s|--source] [-S|--recursive-build] [-v|--verbose] <package1> [<package2> ...]
The package(s) must have a valid name. Use `crew search <pattern>` to search for packages to install.
If `-k` or `--keep` is present, the `CREW_BREW_DIR` (#{CREW_BREW_DIR}) directory will remain.
If `-s` or `--source` is present, the package(s) will be compiled instead of installed via binary.
If `-S` or `--recursive-build` is present, the package(s), including all dependencies, will be compiled instead of installed via binary.
If `-v` or `--verbose` is present, extra information will be displayed.
EOT
when 'list'
puts <<~EOT
List packages
Usage: crew list [-v|--verbose] available|installed|compatible|incompatible
EOT
when 'postinstall'
puts <<~EOT
Display postinstall messages of package(s).
Usage: crew postinstall <package1> [<package2> ...]
The package(s) must be currently installed.
EOT
when 'prop'
if ARGV[2]
valid = nil
properties = prop(true)
properties.each do |p|
if ARGV[2] == p
valid = true
break
end
end
abort 'Invalid property.'.lightred unless valid
case ARGV[2]
when 'conflicts_ok'
puts "The 'conflicts_ok' property bypasses checks for other package file conflicts."
when 'git_clone_deep'
puts "The 'git_clone_deep' property clones the repository without a depth value."
puts "Applicable only when 'source_url' is a git repository."
when 'git_fetchtags'
puts "The 'git_fetchtags' property gets the repository tags."
puts "Applicable only when 'source_url' is a git repository."
when 'is_fake'
puts "Use the 'is_fake' property for packages that simply depend on other packages."
when 'is_musl'
puts "Use the 'is_musl' property for musl specific packages."
when 'is_static'
puts "Use the 'is_static' property for packages which do not require shared dependencies."
when 'no_compile_needed'
puts "Use the 'no_compile_needed' property for packages that do not require pre-built binaries."
when 'no_compress'
puts "Use the 'no_compress' property for packages that do not need compressed files."
when 'no_env_options'
puts "Use the 'no_env_options' property for packages that do not require"
puts 'environment options or to override the default options.'
when 'no_fhs'
puts "The 'no_fhs' property bypasses FHS3 compliance checks."
when 'no_git_submodules'
puts "Use the 'no_git_submodules' property for repositories without git submodules."
puts "Applicable only when 'source_url' is a git repository."
when 'no_links'
puts "Use the 'no_links' property to bypass checks for duplicate links."
when 'no_patchelf'
puts "Use the 'no_patchelf' property to bypass patchelf execution."
when 'no_shrink'
puts "Use the 'no_shrink' property to bypass upx binary compression."
when 'no_strip'
puts "Use the 'no_strip' property to bypass strip execution."
when 'no_lto'
puts "Use the 'no_lto' property to bypass lto usage."
when 'no_zstd'
puts "Use the 'no_zstd' property for the alternate xz compression algorithm."
when 'patchelf'
puts "Use the 'patchelf' property for patchelf execution."
when 'print_source_bashrc'
puts "Prints 'source ~/.bashrc' message at end of install."
when 'run_tests'
puts "Use the 'run_tests' property to execute make check tests."
else
abort "Help for the '#{ARGV[2]}' property is not available.".lightred
end
else
puts <<~EOT
Display all available package boolean properties.
Usage: crew prop
EOT
end
when 'reinstall'
puts <<~EOT
Remove and install package(s).
Usage: crew reinstall [-k|--keep] [-s|--source] [-S|--recursive-build] [-v|--verbose] <package1> [<package2> ...]
If `-k` or `--keep` is present, the `CREW_BREW_DIR` (#{CREW_BREW_DIR}) directory will remain.
If `-s` or `--source` is present, the package(s) will be compiled instead of installed via binary.
If `-S` or `--recursive-build` is present, the package(s), including all dependencies, will be compiled instead of installed via binary.
If `-v` or `--verbose` is present, extra information will be displayed.
EOT
when 'remove'
puts <<~EOT
Remove package(s).
Usage: crew remove [-v|--verbose] <package1> [<package2> ...]
The package(s) must be currently installed.
If `-v` or `--verbose` is present, extra information will be displayed.
EOT
when 'search'
puts <<~EOT
Look for package(s).
Usage: crew search [-v|--verbose] [<pattern> ...]
If <pattern> is omitted, all packages will be returned.
If the package color is " + "green".lightgreen + ", it means the package is installed.
If the package color is " + "red".lightred + ", it means the architecture is not supported.
The <pattern> string can also contain regular expressions.
If `-v` or `--verbose` is present, homepage, version and license will be displayed.
Examples:
crew search ^lib".lightblue + " will display all packages that start with `lib`.
crew search audio".lightblue + " will display all packages with `audio` in the name.
crew search | grep -i audio".lightblue + " will display all packages with `audio` in the name or description.
crew search git -v".lightblue + " will display packages with `git` in the name along with homepage, version and license.
EOT
when 'sysinfo'
puts <<~EOT
Show system information.
Usage: crew sysinfo
If `-v` or `--verbose` is present, show system information with raw markdown.
EOT
when 'update'
puts <<~EOT
Update crew.
Usage: crew update
This only updates crew itself. Use `crew upgrade` to update packages.
Usage: crew update compatible
This updates the crew package compatibility list.
EOT
when 'upgrade'
puts <<~EOT
Update package(s).
Usage: crew upgrade [-v|--verbose] [-s|--source] <package1> [<package2> ...]
If package(s) are omitted, all packages will be updated. Otherwise, specific package(s) will be updated.
Use `crew update` to update crew itself.
If `-s` or `--source` is present, the package(s) will be compiled instead of upgraded via binary.
If `-v` or `--verbose` is present, extra information will be displayed.
EOT
when 'upload'
puts <<~EOT
Upload binaries.
Usage: crew upload [<package1> <package2> ...]
This will update the binary_sha256 hashes in each package and upload binaries to GitLab.
The GITLAB_TOKEN environment variable must be set to access the upstream repository.
If no package(s) are provided, all binaries in `#{CREW_LOCAL_REPO_ROOT}/release/<arch>` will be uploaded.
If `-v` or `--verbose` is present, additional debug information will be displayed.
EOT
when 'whatprovides'
puts <<~EOT
Determine which package(s) contains file(s).
Usage: crew whatprovides <pattern> ...
The <pattern> is a search string which can contain regular expressions.
EOT
else
puts "Available commands: #{@cmds.join(', ')}"
end
end
def cache_build
build_cachefile = File.join(CREW_CACHE_DIR, "#{@pkg.name}-#{@pkg.version}-build-#{@device[:architecture]}.tar.zst")
if CREW_CACHE_ENABLED && File.writable?(CREW_CACHE_DIR)
@@ -655,7 +455,7 @@ def update
# update package lists
Dir.chdir(CREW_LIB_PATH) do
# Set sparse-checkout folders.
system "git sparse-checkout set packages manifest/#{ARCH} lib bin crew tests tools"
system "git sparse-checkout set packages manifest/#{ARCH} lib commands bin crew tests tools"
system 'git sparse-checkout reapply'
system "git fetch #{CREW_REPO} #{CREW_BRANCH}", exception: true
@@ -2097,12 +1897,7 @@ def files_command(args)
end
def help_command(args)
if args['<command>']
help args['<command>']
else
puts 'Usage: crew help <command>'
help
end
Command.help(args['<command>'], args['<subcommand>'])
end
def install_command(args)

211
commands/help.rb Normal file
View File

@@ -0,0 +1,211 @@
require_relative '../lib/const'
class Command
def self.help(command, property)
case command
when 'build'
puts <<~EOT
Build package(s).
Usage: crew build [-k|--keep] [-v|--verbose] <package1> [<package2> ...]
Build package(s) from source and place the archive and checksum in the `CREW_LOCAL_BUILD_DIR/release/<arch>` directory.
Build package(s) from source and place the archive and checksum in the current working directory.
If `-k` or `--keep` is present, the `CREW_BREW_DIR` (#{CREW_BREW_DIR}) directory will remain.
If `-v` or `--verbose` is present, extra information will be displayed.
EOT
when 'const'
puts <<~EOT
Display constant(s).
Usage: crew const [<const1> <const2> ...]
If no constants are provided, all constants will be displayed.
EOT
when 'deps'
puts <<~EOT
Display dependencies of package(s).
Usage: crew deps [-t|--tree] [-b|--include-build-deps] [--exclude-buildessential] <package1> [<package2> ...]
If `-t` or `--tree` specified, dependencies will be printed in a tree-structure format
If `-b` or `--include-build-deps` specified, build dependencies will be included in output
It `--exclude-buildessential` specified, `buildessential` and its dependencies will not be inserted automatically
EOT
when 'download'
puts <<~EOT
Download package(s).
Usage: crew download [-s|--source] [-v|--verbose] <package1> [<package2> ...]
Download package(s) to `CREW_BREW_DIR` (#{CREW_BREW_DIR}), but don't install.
If `-s` or `--source` is present, the source will be downloaded instead of the binary.
If `-v` or `--verbose` is present, extra information will be displayed.
EOT
when 'files'
puts <<~EOT
Display installed files of package(s).
Usage: crew files <package1> [<package2> ...]
The package(s) must be currently installed.
EOT
when 'install'
puts <<~EOT
Install package(s).
Usage: crew install [-k|--keep] [-s|--source] [-S|--recursive-build] [-v|--verbose] <package1> [<package2> ...]
The package(s) must have a valid name. Use `crew search <pattern>` to search for packages to install.
If `-k` or `--keep` is present, the `CREW_BREW_DIR` (#{CREW_BREW_DIR}) directory will remain.
If `-s` or `--source` is present, the package(s) will be compiled instead of installed via binary.
If `-S` or `--recursive-build` is present, the package(s), including all dependencies, will be compiled instead of installed via binary.
If `-v` or `--verbose` is present, extra information will be displayed.
EOT
when 'license'
puts <<~EOT
Display the crew license.
Usage: crew license
EOT
when 'list'
puts <<~EOT
List packages.
Usage: crew list [-v|--verbose] available|installed|compatible|incompatible
EOT
when 'postinstall'
puts <<~EOT
Display postinstall messages of package(s).
Usage: crew postinstall <package1> [<package2> ...]
The package(s) must be currently installed.
EOT
when 'prop'
help_prop(property)
when 'reinstall'
puts <<~EOT
Remove and install package(s).
Usage: crew reinstall [-k|--keep] [-s|--source] [-S|--recursive-build] [-v|--verbose] <package1> [<package2> ...]
If `-k` or `--keep` is present, the `CREW_BREW_DIR` (#{CREW_BREW_DIR}) directory will remain.
If `-s` or `--source` is present, the package(s) will be compiled instead of installed via binary.
If `-S` or `--recursive-build` is present, the package(s), including all dependencies, will be compiled instead of installed via binary.
If `-v` or `--verbose` is present, extra information will be displayed.
EOT
when 'remove'
puts <<~EOT
Remove package(s).
Usage: crew remove [-v|--verbose] <package1> [<package2> ...]
The package(s) must be currently installed.
If `-v` or `--verbose` is present, extra information will be displayed.
EOT
when 'search'
puts <<~EOT
Look for package(s).
Usage: crew search [-v|--verbose] [<pattern> ...]
If <pattern> is omitted, all packages will be returned.
If the package color is " + "green".lightgreen + ", it means the package is installed.
If the package color is " + "red".lightred + ", it means the architecture is not supported.
The <pattern> string can also contain regular expressions.
If `-v` or `--verbose` is present, homepage, version and license will be displayed.
Examples:
crew search ^lib".lightblue + " will display all packages that start with `lib`.
crew search audio".lightblue + " will display all packages with `audio` in the name.
crew search | grep -i audio".lightblue + " will display all packages with `audio` in the name or description.
crew search git -v".lightblue + " will display packages with `git` in the name along with homepage, version and license.
EOT
when 'sysinfo'
puts <<~EOT
Show system information.
Usage: crew sysinfo
If `-v` or `--verbose` is present, show system information with raw markdown.
EOT
when 'update'
puts <<~EOT
Update crew.
Usage: crew update
This only updates crew itself. Use `crew upgrade` to update packages.
Usage: crew update compatible
This updates the crew package compatibility list.
EOT
when 'upgrade'
puts <<~EOT
Update package(s).
Usage: crew upgrade [-v|--verbose] [-s|--source] <package1> [<package2> ...]
If package(s) are omitted, all packages will be updated. Otherwise, specific package(s) will be updated.
Use `crew update` to update crew itself.
If `-s` or `--source` is present, the package(s) will be compiled instead of upgraded via binary.
If `-v` or `--verbose` is present, extra information will be displayed.
EOT
when 'upload'
puts <<~EOT
Upload binaries.
Usage: crew upload [<package1> <package2> ...]
This will update the binary_sha256 hashes in each package and upload binaries to GitLab.
The GITLAB_TOKEN environment variable must be set to access the upstream repository.
If no package(s) are provided, all binaries in `#{CREW_LOCAL_REPO_ROOT}/release/<arch>` will be uploaded.
If `-v` or `--verbose` is present, additional debug information will be displayed.
EOT
when 'version'
puts <<~EOT
Display the crew version.
Usage: crew version
EOT
when 'whatprovides'
puts <<~EOT
Determine which package(s) contains file(s).
Usage: crew whatprovides <pattern> ...
The <pattern> is a search string which can contain regular expressions.
EOT
else
puts <<~EOT
Usage: crew help <command>
Available commands: build, const, deps, download, files, help, install, list, postinstall, prop, reinstall, remove, search, sysinfo, update, upgrade, upload, whatprovides, license, version
EOT
end
end
end
def help_prop(property)
if property
case property
when 'conflicts_ok'
puts "The 'conflicts_ok' property bypasses checks for other package file conflicts."
when 'git_clone_deep'
puts "The 'git_clone_deep' property clones the repository without a depth value."
puts "Applicable only when 'source_url' is a git repository."
when 'git_fetchtags'
puts "The 'git_fetchtags' property gets the repository tags."
puts "Applicable only when 'source_url' is a git repository."
when 'is_fake'
puts "Use the 'is_fake' property for packages that simply depend on other packages."
when 'is_musl'
puts "Use the 'is_musl' property for musl specific packages."
when 'is_static'
puts "Use the 'is_static' property for packages which do not require shared dependencies."
when 'no_compile_needed'
puts "Use the 'no_compile_needed' property for packages that do not require pre-built binaries."
when 'no_compress'
puts "Use the 'no_compress' property for packages that do not need compressed files."
when 'no_env_options'
puts "Use the 'no_env_options' property for packages that do not require"
puts 'environment options or to override the default options.'
when 'no_fhs'
puts "The 'no_fhs' property bypasses FHS3 compliance checks."
when 'no_git_submodules'
puts "Use the 'no_git_submodules' property for repositories without git submodules."
puts "Applicable only when 'source_url' is a git repository."
when 'no_links'
puts "Use the 'no_links' property to bypass checks for duplicate links."
when 'no_patchelf'
puts "Use the 'no_patchelf' property to bypass patchelf execution."
when 'no_shrink'
puts "Use the 'no_shrink' property to bypass upx binary compression."
when 'no_strip'
puts "Use the 'no_strip' property to bypass strip execution."
when 'no_lto'
puts "Use the 'no_lto' property to bypass lto usage."
when 'no_zstd'
puts "Use the 'no_zstd' property for the alternate xz compression algorithm."
when 'patchelf'
puts "Use the 'patchelf' property for patchelf execution."
when 'print_source_bashrc'
puts "Prints 'source ~/.bashrc' message at end of install."
when 'run_tests'
puts "Use the 'run_tests' property to execute make check tests."
else
abort "Invalid property '#{property}'".lightred
end
else
puts <<~EOT
Display all available package boolean properties.
Usage: crew prop
EOT
end
end

2
install.sh
View File

@@ -317,7 +317,7 @@ else
git checkout -f "${BRANCH}"
# Set sparse-checkout folders.
git sparse-checkout set packages "manifest/${ARCH}" lib bin crew tests tools
git sparse-checkout set packages "manifest/${ARCH}" lib commands bin crew tests tools
git reset --hard origin/"${BRANCH}"
fi
echo -e "${RESET}"

2
lib/const.rb
View File

@@ -1,7 +1,7 @@
# lib/const.rb
# Defines common constants used in different parts of crew
CREW_VERSION = '1.43.9'
CREW_VERSION = '1.44.0'
# kernel architecture
KERN_ARCH = `uname -m`.chomp

6
lib/fixup.rb
View File

@@ -10,6 +10,12 @@ if File.exist?("#{CREW_PREFIX}/etc/env.d/00-path") && File.exist?("#{CREW_PREFIX
FileUtils.rm "#{CREW_PREFIX}/etc/env.d/path"
end
# Set new sparse-checkout paths for commands directory
Dir.chdir CREW_LIB_PATH do
system 'git sparse-checkout add commands'
system 'git sparse-checkout reapply'
end
# Check for renamed and deprecated packages, and handle them.
pkg_update_arr = [

32
tests/commands/help.rb Normal file
View File

@@ -0,0 +1,32 @@
require 'minitest/autorun'
require_relative '../../commands/help'
class HelpCommandTest < Minitest::Test
def test_no_arguments
expected_output = <<~EOT
Usage: crew help <command>
Available commands: build, const, deps, download, files, help, install, list, postinstall, prop, reinstall, remove, search, sysinfo, update, upgrade, upload, whatprovides, license, version
EOT
assert_output expected_output, nil do
Command.help(nil, nil)
end
end
def test_const_command
expected_output = <<~EOT
Display constant(s).
Usage: crew const [<const1> <const2> ...]
If no constants are provided, all constants will be displayed.
EOT
assert_output expected_output, nil do
Command.help('const', nil)
end
end
def test_prop_command
expected_output = "Use the 'is_static' property for packages which do not require shared dependencies.\n"
assert_output expected_output, nil do
Command.help('prop', 'is_static')
end
end
end