forked from rust-embedded/rust-raspberrypi-OS-tutorials
-
Notifications
You must be signed in to change notification settings - Fork 0
/
devtool.rb
executable file
·347 lines (262 loc) · 8.18 KB
/
devtool.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
#!/usr/bin/env ruby
# frozen_string_literal: true
# SPDX-License-Identifier: MIT OR Apache-2.0
#
# Copyright (c) 2020-2023 Andre Richter <[email protected]>
require 'rubygems'
require 'bundler/setup'
require 'colorize'
require 'fileutils'
require_relative 'devtool/copyright'
# Actions for tutorial folders.
class TutorialCrate
attr_reader :folder
def initialize(folder)
@folder = folder
end
def tutorial?
/[0-9]/.match?(@folder[0])
end
def clean
puts 'Cleaning '.light_blue + @folder
# No output needed.
Dir.chdir(@folder) { `make clean` }
end
def update
puts "\n\n"
puts 'Updating '.light_blue + @folder
Dir.chdir(@folder) { system('cargo update') }
end
def clippy(bsp)
puts "\n\n"
puts "Clippy #{@folder} - BSP: #{bsp}".light_blue
Dir.chdir(@folder) { exit(1) unless system("BSP=#{bsp} make clippy") }
end
def fmt_cargo_rust(args)
Dir.chdir(@folder) { exit(1) unless system("cargo fmt #{args}") }
end
def make(bsp)
puts "\n\n"
puts "Make #{@folder} - BSP: #{bsp}".light_blue
Dir.chdir(@folder) { exit(1) unless system("BSP=#{bsp} make") }
end
def test(bsp)
return unless boot_test?
puts "\n\n"
puts "Test #{@folder} - BSP: #{bsp}".light_blue
Dir.chdir(@folder) { exit(1) unless system("BSP=#{bsp} make test") }
end
def test_boot(bsp)
return unless boot_test?
puts "\n\n"
puts "Test Boot #{@folder} - BSP: #{bsp}".light_blue
Dir.chdir(@folder) { exit(1) unless system("BSP=#{bsp} make test_boot") }
end
def test_unit(bsp)
return unless unit_integration_tests?
puts "\n\n"
puts "Test Unit #{@folder} - BSP: #{bsp}".light_blue
Dir.chdir(@folder) { exit(1) unless system("BSP=#{bsp} make test_unit") }
end
def test_integration(bsp)
return unless unit_integration_tests?
puts "\n\n"
puts "Test Integration #{@folder} - BSP: #{bsp}".light_blue
Dir.chdir(@folder) { exit(1) unless system("BSP=#{bsp} make test_integration") }
end
private
def boot_test?
Dir.exist?("#{@folder}/tests") || Dir.exist?("#{@folder}/kernel/tests")
end
def unit_integration_tests?
!Dir.glob("#{@folder}/kernel/tests/00_*.rs").empty?
end
end
# Forks commands to all applicable receivers.
class DevTool
def initialize
@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
def clean
@crates.each(&:clean)
end
def update
@crates.each(&:update)
end
def clippy(bsp = nil)
bsp ||= @bsp
@crates.each { |c| c.clippy(bsp) }
end
def diff
tuts = tutorials.map(&:folder)
padding = tuts.map(&:length).max
tuts[0..-2].each_with_index do |original, i|
update = tuts[i + 1]
diff_pair(original, update, padding)
end
end
def fmt
fmt_cargo_rust(check: false)
puts
fmt_prettier(check: false)
end
def fmt_check
fmt_cargo_rust(check: true)
puts
fmt_prettier(check: true)
end
def make(bsp = nil)
bsp ||= @bsp
@crates.each { |c| c.make(bsp) }
end
def make_xtra
return if @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
def test(bsp = nil)
bsp ||= @bsp
@crates.each { |c| c.test(bsp) }
end
def test_boot(bsp = nil)
bsp ||= @bsp
@crates.each { |c| c.test_boot(bsp) }
end
def test_unit(bsp = nil)
bsp ||= @bsp
@crates.each { |c| c.test_unit(bsp) }
end
def test_integration(bsp = nil)
bsp ||= @bsp
@crates.each { |c| c.test_integration(bsp) }
end
def copyright
exit(1) unless copyright_check_files(copyright_source_files)
end
def misspell
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) unless system(".vendor/misspell -error #{files}")
end
def rubocop
puts 'Rubocop'.light_blue
exit(1) unless system('bundle exec rubocop')
end
def ready_for_publish_no_rust
clean
fmt
rubocop
copyright
diff
misspell
clean
end
def ready_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[rpi3 rpi4].freeze
def bsp_from_env
bsp = ENV.fetch('BSP', nil)
return bsp if SUPPORTED_BSPS.include?(bsp)
nil
end
def fmt_cargo_rust(check: false)
args = '-- --check' if check
@crates.each do |c|
print 'Rust cargo fmt '.light_blue
print "#{args} ".light_blue unless args.nil?
puts c.folder
Process.fork { c.fmt_cargo_rust(args) }
end
Process.waitall
end
def fmt_prettier(check: false)
args = if check
'--check'
else
'--write'
end
args += if @user_has_supplied_crates
" #{@crates.map(&:folder).join(' ')}"
else
' .'
end
puts 'Prettier:'.light_blue
exit(1) unless system("./node_modules/.bin/prettier #{args}")
end
def user_supplied_crate_list
folders = ARGV.drop(1)
return nil if folders.empty?
crates = folders.map { |d| "#{d}/Cargo.toml" }.sort
crates.each do |c|
unless File.exist?(c)
puts "Crate not found: #{c}"
exit(1)
end
end
@user_has_supplied_crates = true
crates
end
def tutorials
@crates.select(&:tutorial?)
end
def tracked_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
def diff_pair(original, update, padding)
# Only diff adjacent tutorials. This checks the numbers of the tutorial folders.
return unless original[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.
if original[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
def copyright_source_files
extensions = ['.S', '.rs', '.rb']
# NOTE: The selection result is the return value of the function.
tracked_files.select do |f|
next unless File.exist?(f)
next if f.include?('build.rs')
next if f.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
if commands.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