build.zig

const std = @import("std");
const build_helpers = @import("build_helpers.zig");
const package_name = "ziggy-starkdust";
const package_path = "src/lib.zig";

// List of external dependencies that this package requires.
const external_dependencies = [_]build_helpers.Dependency{
    .{
        .name = "zig-cli",
        .module_name = "zig-cli",
    },
    .{
        .name = "starknet",
        .module_name = "ziggy-starkdust",
    },
};

// Although this function looks imperative, note that its job is to
// declaratively construct a build graph that will be executed by an external
// runner.
pub fn build(b: *std.Build) void {
    const options = b.addOptions();
    options.addOption(bool, "extensive", false);

    // Standard target options allows the person running `zig build` to choose
    // what target to build for. Here we do not override the defaults, which
    // means any target is allowed, and the default is native. Other options
    // for restricting supported target set are available.
    const target = b.standardTargetOptions(.{});

    // Standard optimization options allow the person running `zig build` to select
    // between Debug, ReleaseSafe, ReleaseFast, and ReleaseSmall. Here we do not
    // set a preferred release mode, allowing the user to decide how to optimize.
    const optimize = b.standardOptimizeOption(.{});

    // **************************************************************
    // *            HANDLE DEPENDENCY MODULES                       *
    // **************************************************************
    const dependencies_opts = .{
        .target = target,
        .optimize = optimize,
    };

    // This array can be passed to add the dependencies to lib, executable, tests, etc using `addModule` function.
    const deps = build_helpers.generateModuleDependencies(
        b,
        &external_dependencies,
        dependencies_opts,
    ) catch unreachable;

    // **************************************************************
    // *               ZIGGY STARKDUST AS A MODULE                        *
    // **************************************************************
    // expose ziggy-starkdust as a module
    _ = b.addModule(package_name, .{
        .root_source_file = b.path(package_path),
        .imports = deps,
    });

    // **************************************************************
    // *              ZIGGY STARKDUST AS A LIBRARY                        *
    // **************************************************************
    const lib = b.addStaticLibrary(.{
        .name = "ziggy-starkdust",
        // In this case the main source file is merely a path, however, in more
        // complicated build scripts, this could be a generated file.
        .root_source_file = b.path("src/lib.zig"),
        .target = target,
        .optimize = optimize,
    });
    // Add dependency modules to the library.
    for (deps) |mod| lib.root_module.addImport(
        mod.name,
        mod.module,
    );
    // This declares intent for the library to be installed into the standard
    // location when the user invokes the "install" step (the default step when
    // running `zig build`).
    b.installArtifact(lib);

    // LSP helper for errors (check step)
    {
        const exe_check = b.addExecutable(.{
            .name = "ziggy-starkdust",
            // In this case the main source file is merely a path, however, in more
            // complicated build scripts, this could be a generated file.
            .root_source_file = b.path("src/main.zig"),
            .target = target,
            .optimize = optimize,

            .link_libc = false,
            .omit_frame_pointer = if (optimize == .ReleaseFast) null else false,
            .strip = if (optimize == .ReleaseFast) true else null,
        });
        exe_check.root_module.addOptions("cfg", options);

        // Add dependency modules to the executable.
        for (deps) |mod| exe_check.root_module.addImport(
            mod.name,
            mod.module,
        );

        const check = b.step("check", "Check if cairo-vm compiles");
        check.dependOn(&exe_check.step);
    }

    // **************************************************************
    // *              ZIGGY STARKDUST AS AN EXECUTABLE                    *
    // **************************************************************
    const exe = b.addExecutable(.{
        .name = "ziggy-starkdust",
        // In this case the main source file is merely a path, however, in more
        // complicated build scripts, this could be a generated file.
        .root_source_file = b.path("src/main.zig"),
        .target = target,
        .optimize = optimize,

        .link_libc = false,
        .omit_frame_pointer = if (optimize == .ReleaseFast) null else false,
        .strip = if (optimize == .ReleaseFast) true else null,
    });
    exe.root_module.addOptions("cfg", options);

    // Add dependency modules to the executable.
    for (deps) |mod| exe.root_module.addImport(
        mod.name,
        mod.module,
    );
    // This declares intent for the executable to be installed into the
    // standard location when the user invokes the "install" step (the default
    // step when running `zig build`).
    b.installArtifact(exe);

    // This *creates* a Run step in the build graph, to be executed when another
    // step is evaluated that depends on it. The next line below will establish
    // such a dependency.
    const run_cmd = b.addRunArtifact(exe);

    // By making the run step depend on the install step, it will be run from the
    // installation directory rather than directly from within the cache directory.
    // This is not necessary, however, if the application depends on other installed
    // files, this ensures they will be present and in the expected location.
    run_cmd.step.dependOn(b.getInstallStep());

    // This allows the user to pass arguments to the application in the build
    // command itself, like this: `zig build run -- arg1 arg2 etc`
    if (b.args) |args| {
        run_cmd.addArgs(args);
    }

    integration_test(b, optimize, target, deps, options);

    // This creates a build step. It will be visible in the `zig build --help` menu,
    // and can be selected like this: `zig build run`
    // This will evaluate the `run` step rather than the default, which is "install".
    const run_step = b.step(
        "run",
        "Run the app",
    );
    run_step.dependOn(&run_cmd.step);

    const test_filter = b.option(
        []const u8,
        "test-filter",
        "Skip tests that do not match filter",
    );

    // Creates a step for unit testing. This only builds the test executable
    // but does not run it.
    const unit_tests = b.addTest(.{
        .name = "unit_tests",
        .root_source_file = b.path("src/tests.zig"),
        .target = target,
        .optimize = optimize,
        .filter = test_filter,
    });
    unit_tests.root_module.addOptions("cfg", options);

    // Add dependency modules to the tests.
    for (deps) |mod| unit_tests.root_module.addImport(
        mod.name,
        mod.module,
    );

    const build_unit_tests = b.addInstallArtifact(unit_tests, .{});

    // Creating run step for building unit tests
    const build_test_step = b.step("build-test", "Build test binary");
    build_test_step.dependOn(&lib.step);
    build_test_step.dependOn(&build_unit_tests.step);

    const run_unit_tests = b.addRunArtifact(unit_tests);

    // Similar to creating the run step earlier, this exposes a `test` step to
    // the `zig build --help` menu, providing a way for the user to request
    // running the unit tests.
    const test_step = b.step(
        "test",
        "Run unit tests",
    );

    test_step.dependOn(&lib.step);
    test_step.dependOn(&run_unit_tests.step);
}

fn integration_test(
    b: *std.Build,
    mode: std.builtin.Mode,
    target: std.Build.ResolvedTarget,
    deps: []std.Build.Module.Import,
    options: *std.Build.Step.Options,
) void {
    const binary = b.addExecutable(.{
        .name = "integration_test",
        .root_source_file = b.path("src/integration_tests.zig"),
        .target = target,
        .optimize = mode,
        .omit_frame_pointer = if (mode == .ReleaseFast) true else false,
        .strip = true,
    });

    binary.root_module.addOptions("cfg", options);

    // Add dependency modules to the executable.
    for (deps) |mod| binary.root_module.addImport(
        mod.name,
        mod.module,
    );

    const integration_test_build = b.step("integration_test", "Build cli integration tests");
    integration_test_build.dependOn(&binary.step);

    const install_step = b.addRunArtifact(
        binary,
    );
    integration_test_build.dependOn(&install_step.step);
}