In the `Zigling.printError` method, use a bold red color for the "error:"
string and a dim red color for the error message.
In the `Zigling.check_output` method, use the old color style.
This is necessary since, when trimLines returns `std.mem.Allocator.Error`,
no error message will be displayed to the user.
An alternative is to use `std.Build.Step.fail`, but using @panic("OOM")
is simpler and consistent with existing code.
Have all error messages handled in a single place (printError), by using
the `std.Build.Step.fail` method. Ensure that the first letter in the
error message is lower case and remove coloring, since it is done in the
`ZiglingStep.printError` method.
Additionally, in the `ZiglingStep.check_test` method, remove trailing
whitespace from stderr.
Remove the `ZiglingStep.eval` method and the src/ipc.zig source code.
Use `Step.evalZigProcess`, instead. This greatly simplifies the code.
Print the error messages and error bundle in `ZiglingStep.make`, both in
case of error and success.
Additionally, remove the `ZiglingStep.is_testing` field, since it is no
longer necessary.
Following the implementation in `std.Build.Step.Compile, add the Kind
type to differentiate between a normal executable and a test executable
running zig tests. Replace `Exercise.run_test` field with `kind`.
Compile the exercise in both the exe and test cases, reducing code
duplication.
Add the `check_output` and `check_test` methods in ZiglingStep, in order
to differentiate the code checking a normal executable and a test
executable.
Update the tests to correctly check both the exe and test cases. Remove
the temporary code added in commit 832772c.
Add the Mode enum, so that ZiglingStep can detect if it was called in
normal mode or in named mode.
Update the help method to print the correct message based on the current
build mode.
Remove the following steps, since they are rarely (if never) used and
only increase the complexity of the `build.zig` file:
- install step (zig build -Dn=n install)
- test step (zig build -Dn=n test)
- start step (zig build -Dn=n start)
The only remaining step is the default zigling step (zig build -Dn=n),
where the user can choose the exercise to solve.
Update the tests. Additionally, update CheckNamedStep and CheckStep so
that they can share the same functions.
Closes#299
Removing the install step will simplify the current code.
Copying the exercise executable to the zig-out directory can be done in
`ZiglingStep.
Closes#298
The special eowyn mode was added in order to improve the performance of
the Eowyn Github workflow.
Remove it, since it adds unnecessary complexity to the `build.zig` file.
Closes#297
Commit dbd42bb (Cleaning up zig build output) broke the unit test.
Always use exit code 2, instead of 0. This is the exit code used by the
build runner to notify the compiler to not report any further
diagnostics.
Move the Ziglings logo from the `build` function scope to the global
scope, and make it public so that tests.zig can use it to find the
number of lines to skip, instead of using an hard coded value.
Fixes#295
Some functions and custom build steps incorrectly used a normal comment.
Use a doc-comment instead.
Additionally, use a present tense verb to describe the action of a
function or custom build step.
Update the code in `zig build install` and `zig build -Dn=n install`, so
that exercises that must be skipped are not installed, since it will
cause an error. Ensure that a skip message is printed.
The command fails because the path to the exercises directory was
incorrectly set to "exercises" instead of `work_path`.
The bug was introduced in commit b56bb7b
(build: enable full parallelism when -Dhealed is set).
Remove the comment about not using multi-object loop, since it is
confusing.
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 is necessary in the unit tests, to ensure each test case use a
different exercises directory.
Update test/tests.zig to use the new healed-path option, ensuring that
each temp directory is removed.
In test case 3, 4 and 5, move case_step as the first step in the
dependency chain. This will improve the build summary tree.
In test case 5, remove the dependency to heal_step, since it is not
necessary.
CheckStep, FailStep, fail, HealStep and heal incorrectly used a normal
comment, instead of a doc-comment.
Additionally, improve the documentation for FailStep and HealStep.
In test case 1 and 2, remove the `i` variable and use `ex.number()`
instead.
In test case 2, when checking the exercise output from stderr, also
check that stdout is empty and vice versa.
- Use an anonymous struct when initializing std.Build.Step.
- Rename the builder parameter in the create method to b
- Avoid lines too long
Additionally:
- In the run method, rename output to raw_output in order to make the
next variable names shorter.
- In the compile method, rename zig_file to path.
The code in ZiglingStep copied the error handling used in std.Build in
the past.
Use @panic("OOM") when the error is caused by the allocator failing to
allocate memory.
When handling the error from the eval method, some possible errors are
ignored. The make method will only print the exercise hint and the
help message.
Print the unexpected error message, in the else prong.
Note that FileNotFound can also be considered unexpected.
Rename the doCompile method to compile and add the run method.
The two methods are now called from the make method.
Add the help method, since the error handling of compile and run methods
are now separate.
Remove the obsolete comment for the compile method.
In order to simplify the code, the heal function is called during the
configuration phase, thus resulting in the function being always called
when the build.zig file is run.
This behavior unfortunately causes a serious issue when the user fix a
broken exercise and, during the next step, the heal function tries to heal
the fixed exercise resulting in GNU patch assuming an attempt to reverse
a patch, waiting for input from the terminal.
Run the heal function from the new HealStep step, so that it is called
only during tests.
Rename the outdir constant to work_path, for consistency with build.zig.
Fixes#272
When running `zig build -Dn=n`, the install and uninstall steps where
overridden in order to improve the description.
In recent version of Zig this is no longer allowed.
The name "baseName" is confusing, since it refers to the UNIX basename
command, and not to the basename function in some programming languages
including Zig.
Use the std.fs.path.stem function to remove the file extension, instead
of slicing.
Remove the use of the assertion, since it is no longer necessary.
Instead, add a check to ensure that the exercise must be a Zig source
file in the validate_exercises function.
Update the validate_exercises function to check the last exercise, too.
Currently addExecutable is called 3 times, unnecessarily making the code
more complex.
The method takes as argument the path to the exercises directory.
Additionally, use the new std.Build.ExecutableOptions.link_libc field.
The new field was added in ziglang/zig@adc9b77d5f on 2023-04-13.
Update the required Zig compiler version.
Note that I added the **current** zig version to the changelog, since
the reason for the change is known only to the person updating the
version.
Currently, the code for defining the path to the exercises directory is
duplicate 4 times.
Add the constants `healed_path` and `work_path`, and use work_path
instead of the duplicated if expression. Update ZiglingStep to take
`work_path` instead of `use_healed` as argument.
Reduce code length by using `join` instead of `std.fs.path.join` and
replace the use of a slice with a tuple.
Additionally, in case of an error from the `join` function, use @panic
instead of unreachable.
Document why the special branch, when the exercises are healed by the
eowyn script, has been disabled.
The POSIX standard says that the patch command should not use stdout,
but GNU patch writes the message:
patching file patches/healed/xxx.zig (read from exercises/xxx.zig).
Add the -s flag to suppress these messages.
Note that the heal function from test/tests.zig is called when running
`zig build -Dhealed` because it is executed in the configure phase.
The deadlock was caused by setting stdout behavior to ignore, when
spawning the patch command. When the patch command writes to devnull it
causes some errors and a deadlock.
The cause of the bug is probably Zig using `\Device\Null` from `ntdll`
while git-bash uses `NUL` from `kernel32`.
Restore the job matrix to run on linux, macos and windows.
Remove lines with extra whitespace.
Improve the documentation of the Eowyn workflow.
Remove the single quoting of the workflow names.
Add the zig-out directory, since the install step is available.
Remove the vim backup and swap files, since it is possible to configure
vim to use a custom directory.
Ensure all the directories are anchored to the root directory.
Closes#251
Currently, `zig fmt` exit status is ignored, making it useless.
Ensure that the script terminates early if there is an error.
Print a message to stdout before executing `zig fmt`, in order to make
the possible error more visible.
In test case 1 and 2, move the -Dhealed option before the -Dn option,
for consistency.
Fix a typo in cmd.setName in test case 1 and 2.
Remove a confusing comment in test case 1.
Currently, ZiglingStep prints the raw exercise output. This is not a
problem when executing `zig build` from the shell, but in a unit test it
is necessary to know when the exercise output ends.
Document that Exercise.output should not have trailing whitespace.
Ensure this is true by adding a check in the validate_exercises
function.
Remove trailing whitespace in exercises 68 and 99.
Simplify the output validation in ZiglingStep.makeInternal.
Checking that the length of the actual and expected output is the same
is not necessary, since trailing whitespace has been removed. Simply do
an exact comparison.
Print the trimmed exercise output, instead of the raw output.
This will ensure that the exercise output always ends with only one LF
character.
Fix some small coding style issues.
The current cleanup code is incorrect, since it may delete the healed
directory while one test case is running.
The solution is to make each test case isolate, with its own setup and
teardown. Unfortunately it is currently not possible, since each test
case modify the same directory.
Disable the cleanup step, until a better solution is found.
Currently, if there is an error when creating the patches/healed
directory, the error message will be printed on stderr, but the build
runner will report the test as being successful.
Add the fail function and the FailStep, so that the error will be
correctly handled by the build runner.
Remove the PatchStep, and instead add the heal function so that all the
exercises are healed before starting the tests.
The heal function executes at the configuration phase, but the possible
error is handled by the build runner.
Add the check-exercises.py tool in the new tools directory. It is used
to check that the exercises are correctly formatted, printing on stderr
the invalid ones and the diff in the unified format.
Update the exercises that don't use the canonical zig fmt format.
Update some patches that cause the generated zig file to be incorrectly
formatted.
Add a new github workflow named CI.
Add a job named compat, checking that and old Zig compiler will not fail
with a compiler error, but instead will print an useful error message.
In same cases, the progress messages from the compiler are intermixed
with the messages printed by ZiglingStep.
This intermixing appears in two cases:
- when printing, e.g., the message "Checking 0_arrays2.zig..."
- when printing the compiler errors
Closes#230
Move the code for printing compiler errors and messages to the new
ZiglingStep.printErrors method.
Call printErrors in the Zigling.doCompile method, both in the normal and
error flow.
When handling an error from the Zig IPC, add the case when the compiler
was unable to return the executable path.
Before using the IPC, the error was
"The following command exited with error code 1"
now it is
"The following command failed to communicate the compilation result"
Commit e214c44 (build: update ZiglingStep to the new API) broke again
the compatibility support for old compilers, due to the use of the
multi-object for loop syntax.
Move the Zig IPC support code to src/ipc.zig.
Use the while statement, instead of the for statement.
Update the code to the breaking change in ziglang
commit c96cb98ad (CLI: remove --enable-cache option).
Replace the --enable-cache option with the --listen=- option and use the
Zig IPC to get the path to the executable.
Closes#236
The special case was added because it was used by the Eowyn github
workflow.
As a side effect, however, it prevents testing the normal case used by
users.
Disable it, until a better solution is found.
Update the code to the breaking change in ziglang commit
60eabc0ec (std.Build.CompileStep: remove run() and install())
Update the zig version in the README.md file.
Update PrintStep to always printing to stderr, using std.debug.print, so
that the message is written atomically.
Note that currently it is not an issue, since PrintStep prints the
message before everything else.
Initialize the first step in the chain to the header_step, instead of
making the code more complex handling the first step as a special case
in the for loop.
Commit 0d56ba3 (build: restore the exercise chain) broke the
compatibility support for old compilers, due to the use of the
multi-object for loop syntax.
Use the normal for loop syntax; the change still keep the code readable.
Use the variable `n`, instead of `i`, when referring to the exercise
number; this will improve the readability.
Closes#227
Simplify the code finding the exercise number from the exercise index,
when the -Dn option is set. This is now possible since the exercise
numbers have no holes.
Add the validate_exercises function to check that exercise number are in
the correct order, and call it at the start of the build function.
Add tests, with 2 test cases.
Currently, exercises not working with the current Zig compiler are
commented. This is problematic, since the exercise key and exercise
index are no longer consistent.
Add the skip field to the Excercise struct. Update ZiglingStep to
support it and add a new SkipStep step to support it when using the
standard build step.
When running, as an example, `zig build -Dhealed -Dn=93 test`, the build
fails, because the `test` step use the standard CompileStep, instead of
ZiglingStep.
Ensure that exercises using libc are correctly built.
Closes#229
The eowyn.sh script is used in a github workflow, but after
commit 0d56ba3 (build: restore the exercise chain), the github action
will take more time to complete.
Enable full build parallelism, when -Dhealed is true and -Dn is null.
Use the standard CompileStep and RunStep, instead of ZiglingStep.
On my PC, this change reduces the build time by about 30%.
The new parallel build support in Zig broke the exercise chain, so that
each esercise check is no longer strictly serialized.
1. Add the Dexno option, in order to isolate the chain starting from a
named exercise from the normal chain, thus simplify the code.
The current code have an additional issue: it added 4 x n steps,
making reading the help message or the list of steps very hard.
Add only the `install`, `uninstall`, `zigling`, `test` and `start`
steps. The last three steps match the old steps `n`, `n_test` and
`n_start`.
The default step is zigling (note the singular form).
The `install` step override the builtin install step, showing a
custom description and matches the old `n_install` step.
The uninstall step was added for consistency, so that the
description is consistent.
Setup a new chain starting at `zig build -Dexno=n start` so that it
is stricly serialized.
The behavior should be the same as the old one.
2. Handle the code for all the exercises separately.
Add only the `ziglings step`, making it the default step, in
addition to the install and uninstall steps.
Setup a new chain starting at the first exercise, to that it is
strictly serialized.
The behavior should be the same as the old one.
The current code has a know issue: the messages from the ZiglingStep and
the ones from the compiler compilation progress are interleaved, but each
message is written atomically, due to the use of `std.debug.getStderrMutex()`.
Update the README.md file.
Closes#202
Replace the description of the named_install step from
"Install {s} to zig-cache/bin" to "Copy {s} to prefix path". The latter
has been adapded from the description of the builtin install step.
Ad an empty line before the build_step variable, in order to improve
readability.
Closes#213
Remove the logo step, and use PrintStep for the header step.
The logo step was added as a quick fix after the Builder.addLog function
was removed.
Now the logo is no longer shown when running `zig build -l` or
`zig build -h`.
The version check for Zig 0.6.0 was incorrect since commit
971ab7f (Use a zig build script to run ziglings).
Move compatibility support to a separate file, in order to simplify
build.zig.
In case of incompatible version, exit with code 3 instead of 0, in order
to detect the case of failure in a test (to be implemented).
Remove the use of comptime when checking compatibility at the start of
the build function, since it is not necessary.
Closes#210.
Currently, the logo is always printed when the build script is executed,
resulting in the logo being printed twice with `zig build -h` and
`zig build -l`.
Make the logo a build step, so that the logo is printed to stderr only
when necessary.
Closes#211
Manlio Perillo