devtool.rb

#!/usr/bin/env ruby
# frozen_string_literal: true

# SPDX-License-Identifier: MIT OR Apache-2.0
#
# Copyright (c) 2020-2023 Andre Richter <andre.o.richter@gmail.com>

require'rubygems'
require'bundler/setup'
require'colorize'
require'fileutils'
require_relative'devtool/copyright'

# Actions for tutorial folders.
classTutorialCrate
attr_reader:folder

definitialize(folder)
@folder=folder
end

deftutorial?
/[0-9]/.match?(@folder[0])
end

defclean
puts'Cleaning '.light_blue + @folder

# No output needed.
Dir.chdir(@folder){`make clean`}
end

defupdate
puts"\n\n"
puts'Updating '.light_blue + @folder

Dir.chdir(@folder){system('cargo update')}
end

defclippy(bsp)
puts"\n\n"
puts"Clippy #{@folder} - BSP: #{bsp}".light_blue

Dir.chdir(@folder){exit(1)unlesssystem("BSP=#{bsp} make clippy")}
end

deffmt_cargo_rust(args)
Dir.chdir(@folder){exit(1)unlesssystem("cargo fmt #{args}")}
end

defmake(bsp)
puts"\n\n"
puts"Make #{@folder} - BSP: #{bsp}".light_blue

Dir.chdir(@folder){exit(1)unlesssystem("BSP=#{bsp} make")}
end

deftest(bsp)
returnunlessboot_test?

puts"\n\n"
puts"Test #{@folder} - BSP: #{bsp}".light_blue

Dir.chdir(@folder){exit(1)unlesssystem("BSP=#{bsp} make test")}
end

deftest_boot(bsp)
returnunlessboot_test?

puts"\n\n"
puts"Test Boot #{@folder} - BSP: #{bsp}".light_blue

Dir.chdir(@folder){exit(1)unlesssystem("BSP=#{bsp} make test_boot")}
end

deftest_unit(bsp)
returnunlessunit_integration_tests?

puts"\n\n"
puts"Test Unit #{@folder} - BSP: #{bsp}".light_blue

Dir.chdir(@folder){exit(1)unlesssystem("BSP=#{bsp} make test_unit")}
end

deftest_integration(bsp)
returnunlessunit_integration_tests?

puts"\n\n"
puts"Test Integration #{@folder} - BSP: #{bsp}".light_blue

Dir.chdir(@folder){exit(1)unlesssystem("BSP=#{bsp} make test_integration")}
end

private

defboot_test?
Dir.exist?("#{@folder}/tests") || Dir.exist?("#{@folder}/kernel/tests")
end

defunit_integration_tests?
 !Dir.glob("#{@folder}/kernel/tests/00_*.rs").empty?
end
end

# Forks commands to all applicable receivers.
classDevTool
definitialize
@user_has_supplied_crates=false
@bsp=bsp_from_env || SUPPORTED_BSPS.first

cl=user_supplied_crate_list || Dir['*/Cargo.toml']
@crates=cl.map{ |c| TutorialCrate.new(c.delete_suffix('/Cargo.toml'))}
end

defclean
@crates.each(&:clean)
end

defupdate
@crates.each(&:update)
end

defclippy(bsp=nil)
bsp ||= @bsp

@crates.each{ |c| c.clippy(bsp)}
end

defdiff
tuts=tutorials.map(&:folder)
padding=tuts.map(&:length).max

tuts[0..-2].each_with_indexdo |original,i|
update=tuts[i + 1]
diff_pair(original,update,padding)
end
end

deffmt
fmt_cargo_rust(check: false)
puts
fmt_prettier(check: false)
end

deffmt_check
fmt_cargo_rust(check: true)
puts
fmt_prettier(check: true)
end

defmake(bsp=nil)
bsp ||= @bsp

@crates.each{ |c| c.make(bsp)}
end

defmake_xtra
returnif@user_has_supplied_crates

puts"\n\n"
puts'Make Xtra stuff'.light_blue
system('cd *_uart_chainloader && bash update.sh')
system('cd X1_JTAG_boot && bash update.sh')
end

deftest(bsp=nil)
bsp ||= @bsp

@crates.each{ |c| c.test(bsp)}
end

deftest_boot(bsp=nil)
bsp ||= @bsp

@crates.each{ |c| c.test_boot(bsp)}
end

deftest_unit(bsp=nil)
bsp ||= @bsp

@crates.each{ |c| c.test_unit(bsp)}
end

deftest_integration(bsp=nil)
bsp ||= @bsp

@crates.each{ |c| c.test_integration(bsp)}
end

defcopyright
exit(1)unlesscopyright_check_files(copyright_source_files)
end

defmisspell
puts'Misspell'.light_blue

translations=['README.CN.md','README.ES.md']
files=tracked_files.reject{ |f| translations.include?(File.basename(f))}
files=files.join(' ')

exit(1)unlesssystem(".vendor/misspell -error #{files}")
end

defrubocop
puts'Rubocop'.light_blue
exit(1)unlesssystem('bundle exec rubocop')
end

defready_for_publish_no_rust
clean
fmt
rubocop
copyright
diff
misspell
clean
end

defready_for_publish
ready_for_publish_no_rust

make_xtra
clippy('rpi4')
clippy('rpi3')
test_boot('rpi3')
test_unit('rpi3')
test_integration('rpi3')
clean
end

private

SUPPORTED_BSPS=%w[rpi3rpi4].freeze

defbsp_from_env
bsp=ENV.fetch('BSP',nil)

returnbspifSUPPORTED_BSPS.include?(bsp)

nil
end

deffmt_cargo_rust(check: false)
args='-- --check'ifcheck

@crates.eachdo |c|
print'Rust cargo fmt '.light_blue
print"#{args} ".light_blueunlessargs.nil?
putsc.folder

Process.fork{c.fmt_cargo_rust(args)}
end
Process.waitall
end

deffmt_prettier(check: false)
args=ifcheck
'--check'
else
'--write'
end

args += if@user_has_supplied_crates
" #{@crates.map(&:folder).join(' ')}"
else
' .'
end

puts'Prettier:'.light_blue
exit(1)unlesssystem("./node_modules/.bin/prettier #{args}")
end

defuser_supplied_crate_list
folders=ARGV.drop(1)

returnniliffolders.empty?

crates=folders.map{ |d| "#{d}/Cargo.toml"}.sort
crates.eachdo |c|
unlessFile.exist?(c)
puts"Crate not found: #{c}"
exit(1)
end
end

@user_has_supplied_crates=true
crates
end

deftutorials
@crates.select(&:tutorial?)
end

deftracked_files
crate_list=@crates.map(&:folder).join(' ')if@user_has_supplied_crates

`git ls-files #{crate_list}`.split("\n")# crates_list == nil means all files
end

defdiff_pair(original,update,padding)
# Only diff adjacent tutorials. This checks the numbers of the tutorial folders.
returnunlessoriginal[0..1].to_i + 1 == update[0..1].to_i

# Skip for tutorial 11. Due to the change to virtual manifest, the diff is rather
# unreadable.
iforiginal[0..1].to_i == 11
puts'Skipping '.light_yellow +
"#{original}: Too noisy due to change to virtual manifest"
return
end

puts'Diffing '.light_blue + original.ljust(padding) + " -> #{update}"
system("bash utils/diff_tut_folders.bash #{original}#{update}")
end

defcopyright_source_files
extensions=['.S','.rs','.rb']

# NOTE: The selection result is the return value of the function.
tracked_files.selectdo |f|
nextunlessFile.exist?(f)
nextiff.include?('build.rs')
nextiff.include?('boot_test_string.rb')

f.include?('Makefile') ||
f.include?('Dockerfile') ||
extensions.include?(File.extname(f))
end
end
end

## -------------------------------------------------------------------------------------------------
## Execution starts here
## -------------------------------------------------------------------------------------------------
tool=DevTool.new
cmd=ARGV[0]
commands=tool.public_methods(false).sort

ifcommands.include?(cmd&.to_sym)
tool.public_send(cmd)
else
puts"Usage: ./#{__FILE__.split('/').last} COMMAND [optional list of folders]"
puts
puts'Commands:'
commands.each{ |m| puts" #{m}"}
exit(1)
end