mirror of
https://codeberg.org/andyscott/ziglings.git
synced 2024-12-21 21:53:11 -05:00
build: use multiline string literals when necessary
Update the output and hint fields in the `exercises` slice to use a multiline string literal when the string have multiple lines or use the `"` character. This will greatly improve readability. Additionally, remove the trailing whitespace on each line and check it in the validate_exercises function. Update the output comparison logic in ZiglingStep, since the current code assumes that the string has only one line. Update test/tests.zig to use the new `CheckNamedStep` in test case 1, since RunStep.StdIo.Check is no longer able to correctly check the output. Fixes #283
This commit is contained in:
Manlio Perillo
parent
397c6671c0
commit
1dd5852bec
2 changed files with 178 additions and 33 deletions
151
build.zig
151
build.zig
|
|
@ -316,9 +316,11 @@ const ZiglingStep = struct {
|
|||
}
|
||||
|
||||
// Validate the output.
|
||||
const output = std.mem.trimRight(u8, raw_output, " \r\n");
|
||||
const exercise_output = std.mem.trimRight(u8, self.exercise.output, " \r\n");
|
||||
if (!std.mem.eql(u8, output, exercise_output)) {
|
||||
// NOTE: exercise.output can never contain a CR character.
|
||||
// See https://ziglang.org/documentation/master/#Source-Encoding.
|
||||
const output = try trimLines(b.allocator, raw_output);
|
||||
const exercise_output = self.exercise.output;
|
||||
if (!std.mem.eql(u8, output, self.exercise.output)) {
|
||||
const red = red_text;
|
||||
const reset = reset_text;
|
||||
|
||||
|
|
@ -555,6 +557,26 @@ fn resetLine() void {
|
|||
if (use_color_escapes) print("{s}", .{"\x1b[2K\r"});
|
||||
}
|
||||
|
||||
/// Remove trailing whitespace for each line in buf, also ensuring that there
|
||||
/// are no trailing LF characters at the end.
|
||||
pub fn trimLines(allocator: std.mem.Allocator, buf: []const u8) ![]const u8 {
|
||||
var list = try std.ArrayList(u8).initCapacity(allocator, buf.len);
|
||||
|
||||
var iter = std.mem.split(u8, buf, " \n");
|
||||
while (iter.next()) |line| {
|
||||
// TODO: trimming CR characters is probably not necessary.
|
||||
const data = std.mem.trimRight(u8, line, " \r");
|
||||
try list.appendSlice(data);
|
||||
try list.append('\n');
|
||||
}
|
||||
|
||||
const result = try list.toOwnedSlice(); // TODO: probably not necessary
|
||||
|
||||
// Remove the trailing LF character, that is always present in the exercise
|
||||
// output.
|
||||
return std.mem.trimRight(u8, result, "\n");
|
||||
}
|
||||
|
||||
// Print a message to stderr.
|
||||
const PrintStep = struct {
|
||||
step: Step,
|
||||
|
|
@ -616,7 +638,7 @@ const SkipStep = struct {
|
|||
// Check that each exercise number, excluding the last, forms the sequence
|
||||
// `[1, exercise.len)`.
|
||||
//
|
||||
// Additionally check that the output field does not contain trailing whitespace.
|
||||
// Additionally check that the output field lines doesn't have trailing whitespace.
|
||||
fn validate_exercises() bool {
|
||||
// Don't use the "multi-object for loop" syntax, in order to avoid a syntax
|
||||
// error with old Zig compilers.
|
||||
|
|
@ -636,13 +658,16 @@ fn validate_exercises() bool {
|
|||
return false;
|
||||
}
|
||||
|
||||
const output = std.mem.trimRight(u8, ex.output, " \r\n");
|
||||
if (output.len != ex.output.len) {
|
||||
print("exercise {s} output field has extra trailing whitespace\n", .{
|
||||
ex.main_file,
|
||||
});
|
||||
var iter = std.mem.split(u8, ex.output, "\n");
|
||||
while (iter.next()) |line| {
|
||||
const output = std.mem.trimRight(u8, line, " \r");
|
||||
if (output.len != line.len) {
|
||||
print("exercise {s} output field lines have trailing whitespace\n", .{
|
||||
ex.main_file,
|
||||
});
|
||||
|
||||
return false;
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
if (!std.mem.endsWith(u8, ex.main_file, ".zig")) {
|
||||
|
|
@ -659,7 +684,13 @@ const exercises = [_]Exercise{
|
|||
.{
|
||||
.main_file = "001_hello.zig",
|
||||
.output = "Hello world!",
|
||||
.hint = "DON'T PANIC!\nRead the error above.\nSee how it has something to do with 'main'?\nOpen up the source file as noted and read the comments.\nYou can do this!",
|
||||
.hint =
|
||||
\\DON'T PANIC!
|
||||
\\Read the error above.
|
||||
\\See how it has something to do with 'main'?
|
||||
\\Open up the source file as noted and read the comments.
|
||||
\\You can do this!
|
||||
,
|
||||
},
|
||||
.{
|
||||
.main_file = "002_std.zig",
|
||||
|
|
@ -687,7 +718,11 @@ const exercises = [_]Exercise{
|
|||
},
|
||||
.{
|
||||
.main_file = "007_strings2.zig",
|
||||
.output = "Ziggy played guitar\nJamming good with Andrew Kelley\nAnd the Spiders from Mars",
|
||||
.output =
|
||||
\\Ziggy played guitar
|
||||
\\Jamming good with Andrew Kelley
|
||||
\\And the Spiders from Mars
|
||||
,
|
||||
.hint = "Please fix the lyrics!",
|
||||
},
|
||||
.{
|
||||
|
|
@ -818,7 +853,13 @@ const exercises = [_]Exercise{
|
|||
},
|
||||
.{
|
||||
.main_file = "036_enums2.zig",
|
||||
.output = "<p>\n <span style=\"color: #ff0000\">Red</span>\n <span style=\"color: #00ff00\">Green</span>\n <span style=\"color: #0000ff\">Blue</span>\n</p>",
|
||||
.output =
|
||||
\\<p>
|
||||
\\ <span style="color: #ff0000">Red</span>
|
||||
\\ <span style="color: #00ff00">Green</span>
|
||||
\\ <span style="color: #0000ff">Blue</span>
|
||||
\\</p>
|
||||
,
|
||||
.hint = "I'm feeling blue about this.",
|
||||
},
|
||||
.{
|
||||
|
|
@ -827,7 +868,10 @@ const exercises = [_]Exercise{
|
|||
},
|
||||
.{
|
||||
.main_file = "038_structs2.zig",
|
||||
.output = "Character 1 - G:20 H:100 XP:10\nCharacter 2 - G:10 H:100 XP:20",
|
||||
.output =
|
||||
\\Character 1 - G:20 H:100 XP:10
|
||||
\\Character 2 - G:10 H:100 XP:20
|
||||
,
|
||||
},
|
||||
.{
|
||||
.main_file = "039_pointers.zig",
|
||||
|
|
@ -848,7 +892,10 @@ const exercises = [_]Exercise{
|
|||
},
|
||||
.{
|
||||
.main_file = "043_pointers5.zig",
|
||||
.output = "Wizard (G:10 H:100 XP:20)\n Mentor: Wizard (G:10000 H:100 XP:2340)",
|
||||
.output =
|
||||
\\Wizard (G:10 H:100 XP:20)
|
||||
\\ Mentor: Wizard (G:10000 H:100 XP:2340)
|
||||
,
|
||||
},
|
||||
.{
|
||||
.main_file = "044_quiz5.zig",
|
||||
|
|
@ -889,7 +936,10 @@ const exercises = [_]Exercise{
|
|||
},
|
||||
.{
|
||||
.main_file = "052_slices.zig",
|
||||
.output = "Hand1: A 4 K 8 \nHand2: 5 2 Q J",
|
||||
.output =
|
||||
\\Hand1: A 4 K 8
|
||||
\\Hand2: 5 2 Q J
|
||||
,
|
||||
},
|
||||
.{
|
||||
.main_file = "053_slices2.zig",
|
||||
|
|
@ -956,7 +1006,11 @@ const exercises = [_]Exercise{
|
|||
},
|
||||
.{
|
||||
.main_file = "068_comptime3.zig",
|
||||
.output = "Minnow (1:32, 4 x 2)\nShark (1:16, 8 x 5)\nWhale (1:1, 143 x 95)",
|
||||
.output =
|
||||
\\Minnow (1:32, 4 x 2)
|
||||
\\Shark (1:16, 8 x 5)
|
||||
\\Whale (1:1, 143 x 95)
|
||||
,
|
||||
},
|
||||
.{
|
||||
.main_file = "069_comptime4.zig",
|
||||
|
|
@ -964,7 +1018,9 @@ const exercises = [_]Exercise{
|
|||
},
|
||||
.{
|
||||
.main_file = "070_comptime5.zig",
|
||||
.output = "\"Quack.\" ducky1: true, \"Squeek!\" ducky2: true, ducky3: false",
|
||||
.output =
|
||||
\\"Quack." ducky1: true, "Squeek!" ducky2: true, ducky3: false
|
||||
,
|
||||
.hint = "Have you kept the wizard hat on?",
|
||||
},
|
||||
.{
|
||||
|
|
@ -1015,7 +1071,9 @@ const exercises = [_]Exercise{
|
|||
},
|
||||
.{
|
||||
.main_file = "082_anonymous_structs3.zig",
|
||||
.output = "\"0\"(bool):true \"1\"(bool):false \"2\"(i32):42 \"3\"(f32):3.14159202e+00",
|
||||
.output =
|
||||
\\"0"(bool):true "1"(bool):false "2"(i32):42 "3"(f32):3.14159202e+00
|
||||
,
|
||||
.hint = "This one is a challenge! But you have everything you need.",
|
||||
},
|
||||
.{
|
||||
|
|
@ -1069,7 +1127,12 @@ const exercises = [_]Exercise{
|
|||
|
||||
.{
|
||||
.main_file = "092_interfaces.zig",
|
||||
.output = "Daily Insect Report:\nAnt is alive.\nBee visited 17 flowers.\nGrasshopper hopped 32 meters.",
|
||||
.output =
|
||||
\\Daily Insect Report:
|
||||
\\Ant is alive.
|
||||
\\Bee visited 17 flowers.
|
||||
\\Grasshopper hopped 32 meters.
|
||||
,
|
||||
},
|
||||
.{
|
||||
.main_file = "093_hello_c.zig",
|
||||
|
|
@ -1099,7 +1162,40 @@ const exercises = [_]Exercise{
|
|||
},
|
||||
.{
|
||||
.main_file = "099_formatting.zig",
|
||||
.output = "\n X | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 \n---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+\n 1 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 \n\n 2 | 2 4 6 8 10 12 14 16 18 20 22 24 26 28 30 \n\n 3 | 3 6 9 12 15 18 21 24 27 30 33 36 39 42 45 \n\n 4 | 4 8 12 16 20 24 28 32 36 40 44 48 52 56 60 \n\n 5 | 5 10 15 20 25 30 35 40 45 50 55 60 65 70 75 \n\n 6 | 6 12 18 24 30 36 42 48 54 60 66 72 78 84 90 \n\n 7 | 7 14 21 28 35 42 49 56 63 70 77 84 91 98 105 \n\n 8 | 8 16 24 32 40 48 56 64 72 80 88 96 104 112 120 \n\n 9 | 9 18 27 36 45 54 63 72 81 90 99 108 117 126 135 \n\n10 | 10 20 30 40 50 60 70 80 90 100 110 120 130 140 150 \n\n11 | 11 22 33 44 55 66 77 88 99 110 121 132 143 154 165 \n\n12 | 12 24 36 48 60 72 84 96 108 120 132 144 156 168 180 \n\n13 | 13 26 39 52 65 78 91 104 117 130 143 156 169 182 195 \n\n14 | 14 28 42 56 70 84 98 112 126 140 154 168 182 196 210 \n\n15 | 15 30 45 60 75 90 105 120 135 150 165 180 195 210 225",
|
||||
.output =
|
||||
\\
|
||||
\\ X | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
|
||||
\\---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
|
||||
\\ 1 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
|
||||
\\
|
||||
\\ 2 | 2 4 6 8 10 12 14 16 18 20 22 24 26 28 30
|
||||
\\
|
||||
\\ 3 | 3 6 9 12 15 18 21 24 27 30 33 36 39 42 45
|
||||
\\
|
||||
\\ 4 | 4 8 12 16 20 24 28 32 36 40 44 48 52 56 60
|
||||
\\
|
||||
\\ 5 | 5 10 15 20 25 30 35 40 45 50 55 60 65 70 75
|
||||
\\
|
||||
\\ 6 | 6 12 18 24 30 36 42 48 54 60 66 72 78 84 90
|
||||
\\
|
||||
\\ 7 | 7 14 21 28 35 42 49 56 63 70 77 84 91 98 105
|
||||
\\
|
||||
\\ 8 | 8 16 24 32 40 48 56 64 72 80 88 96 104 112 120
|
||||
\\
|
||||
\\ 9 | 9 18 27 36 45 54 63 72 81 90 99 108 117 126 135
|
||||
\\
|
||||
\\10 | 10 20 30 40 50 60 70 80 90 100 110 120 130 140 150
|
||||
\\
|
||||
\\11 | 11 22 33 44 55 66 77 88 99 110 121 132 143 154 165
|
||||
\\
|
||||
\\12 | 12 24 36 48 60 72 84 96 108 120 132 144 156 168 180
|
||||
\\
|
||||
\\13 | 13 26 39 52 65 78 91 104 117 130 143 156 169 182 195
|
||||
\\
|
||||
\\14 | 14 28 42 56 70 84 98 112 126 140 154 168 182 196 210
|
||||
\\
|
||||
\\15 | 15 30 45 60 75 90 105 120 135 150 165 180 195 210 225
|
||||
,
|
||||
},
|
||||
.{
|
||||
.main_file = "100_for4.zig",
|
||||
|
|
@ -1107,10 +1203,19 @@ const exercises = [_]Exercise{
|
|||
},
|
||||
.{
|
||||
.main_file = "101_for5.zig",
|
||||
.output = "1. Wizard (Gold: 25, XP: 40)\n2. Bard (Gold: 11, XP: 17)\n3. Bard (Gold: 5, XP: 55)\n4. Warrior (Gold: 7392, XP: 21)",
|
||||
.output =
|
||||
\\1. Wizard (Gold: 25, XP: 40)
|
||||
\\2. Bard (Gold: 11, XP: 17)
|
||||
\\3. Bard (Gold: 5, XP: 55)
|
||||
\\4. Warrior (Gold: 7392, XP: 21)
|
||||
,
|
||||
},
|
||||
.{
|
||||
.main_file = "999_the_end.zig",
|
||||
.output = "\nThis is the end for now!\nWe hope you had fun and were able to learn a lot, so visit us again when the next exercises are available.",
|
||||
.output =
|
||||
\\
|
||||
\\This is the end for now!
|
||||
\\We hope you had fun and were able to learn a lot, so visit us again when the next exercises are available.
|
||||
,
|
||||
},
|
||||
};
|
||||
|
|
|
|||
|
|
@ -43,18 +43,17 @@ pub fn addCliTests(b: *std.Build, exercises: []const Exercise) *Step {
|
|||
});
|
||||
cmd.setName(b.fmt("zig build -Dhealed -Dn={} test", .{n}));
|
||||
cmd.expectExitCode(0);
|
||||
|
||||
if (ex.check_stdout) {
|
||||
expectStdOutMatch(cmd, ex.output);
|
||||
cmd.expectStdErrEqual("");
|
||||
} else {
|
||||
expectStdErrMatch(cmd, ex.output);
|
||||
cmd.expectStdOutEqual("");
|
||||
}
|
||||
|
||||
cmd.step.dependOn(&heal_step.step);
|
||||
|
||||
case_step.dependOn(&cmd.step);
|
||||
const output = if (ex.check_stdout)
|
||||
cmd.captureStdOut()
|
||||
else
|
||||
cmd.captureStdErr();
|
||||
|
||||
const verify = CheckNamedStep.create(b, ex, output);
|
||||
verify.step.dependOn(&cmd.step);
|
||||
|
||||
case_step.dependOn(&verify.step);
|
||||
}
|
||||
|
||||
const cleanup = b.addRemoveDirTree(tmp_path);
|
||||
|
|
@ -196,6 +195,47 @@ fn createCase(b: *Build, name: []const u8) *Step {
|
|||
return case_step;
|
||||
}
|
||||
|
||||
/// Checks the output of `zig build -Dn=n test`.
|
||||
const CheckNamedStep = struct {
|
||||
step: Step,
|
||||
exercise: Exercise,
|
||||
output: FileSource,
|
||||
|
||||
pub fn create(owner: *Build, exercise: Exercise, output: FileSource) *CheckNamedStep {
|
||||
const self = owner.allocator.create(CheckNamedStep) catch @panic("OOM");
|
||||
self.* = .{
|
||||
.step = Step.init(.{
|
||||
.id = .custom,
|
||||
.name = "check-named",
|
||||
.owner = owner,
|
||||
.makeFn = make,
|
||||
}),
|
||||
.exercise = exercise,
|
||||
.output = output,
|
||||
};
|
||||
|
||||
return self;
|
||||
}
|
||||
|
||||
fn make(step: *Step, _: *std.Progress.Node) !void {
|
||||
const b = step.owner;
|
||||
const self = @fieldParentPtr(CheckNamedStep, "step", step);
|
||||
|
||||
// Allow up to 1 MB of output capture.
|
||||
const max_bytes = 1 * 1024 * 1024;
|
||||
const path = self.output.getPath(b);
|
||||
const raw_output = try fs.cwd().readFileAlloc(b.allocator, path, max_bytes);
|
||||
|
||||
const actual = try root.trimLines(b.allocator, raw_output);
|
||||
const expect = self.exercise.output;
|
||||
if (!mem.eql(u8, expect, actual)) {
|
||||
return step.fail("{s}: expected to see \"{s}\", found \"{s}\"", .{
|
||||
self.exercise.main_file, expect, actual,
|
||||
});
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
/// Checks the output of `zig build` or `zig build -Dn=1 start`.
|
||||
const CheckStep = struct {
|
||||
step: Step,
|
||||
|
|
|
|||
Loading…
Reference in a new issue