feat: Add test harness (#11)

Author: eureka-cpu

README.md

@@ -11,6 +11,7 @@ The entire interface can be summarized by the following excerpt of the manpage:
 ns [OPTION]… [SOURCE]… [TARGET_DIR]
 ```
 
+> <pre>
 > Each SOURCE is positional and may be one of:
 > 
 >   URI#ATTR            select a devshell or package from a flake
@@ -23,6 +24,7 @@ ns [OPTION]… [SOURCE]… [TARGET_DIR]
 > 
 > If a single SOURCE is provided and it is a directory, ns switches into
 > it by default unless a TARGET_DIR is explicitly given.
+> </pre>
 
 Try it from anywhere:
 

bin/main.ml

@@ -2,7 +2,7 @@ open Ns
 open Ns.Cmd
 open Ns.Util
 
-let main ({ installables; target_info } : Cli.strategy) =
+let main ({ installables; target_info; printcmd } : Cli.strategy) =
   let ({ entrypoint; attribute; subshell_dir } : Cli.target_info) = target_info in
   Option.value ~default:(Option.value ~default:(Sys.getcwd ()) entrypoint) subshell_dir
   |> Unix.cd;
@@ -26,7 +26,7 @@ let main ({ installables; target_info } : Cli.strategy) =
       |>+ [ "--command"; Unix.shell ]
     | None -> Cmd.builder "nix" |>+ [ "shell" ] |>+ installables
   in
-  ignore (Cmd.run cmd)
+  if printcmd then print_endline (Cmd.to_string cmd) else ignore (Cmd.run cmd)
 ;;
 
 Cli.eval main

dune-project

@@ -2,7 +2,7 @@
 
 (name ns)
 
-(version 0.4.0)
+(version 0.4.1)
 
 (generate_opam_files true)
 

flake.nix

@@ -40,6 +40,7 @@
             doCheck = true;
             nativeCheckInputs = attrValues {
               inherit (pkgs) ocamlformat;
+              inherit (pkgs) rustc clippy rustfmt;
             };
             checkPhase = ''
               red() {
@@ -50,9 +51,24 @@
                 printf "$(red "Error:") Generated opam file does not match provided opam file\n"
                 exit 1
               fi
+              if ! dune test --force --no-buffer --display=quiet; then
+                printf "\n"
+                printf "$(red "Error:") dune test reported test failures\n"
+                exit 1
+              fi
+              if ! clippy-driver --test "${finalAttrs.src}/test/test_ns.rs" -Dwarnings; then
+                printf "\n"
+                printf "$(red "Error:") test.rs contains warnings\n"
+                exit 1
+              fi
               if ! dune fmt --diff-command="diff --color=always"; then
                 printf "\n"
-                printf "$(red "Error:") Some files are not properly formatted\n"
+                printf "$(red "Error:") Some OCaml files are not properly formatted\n"
+                exit 1
+              fi
+              if ! rustfmt --check --color=always "${finalAttrs.src}/test/test_ns.rs"; then
+                printf "\n"
+                printf "$(red "Error:") test.rs is not properly formatted\n"
                 exit 1
               fi
             '';
@@ -78,14 +94,17 @@
         default = pkgs.mkShell {
           inputsFrom = [ self.packages.${pkgs.stdenv.hostPlatform.system}.default ];
           packages = attrValues {
-            inherit (pkgs) ocamlformat nil;
+            inherit (pkgs) ocamlformat nil rustc clippy rustfmt;
             inherit (pkgs.ocamlPackages) ocaml-lsp odoc;
           };
           shellHook = ''
             dune build # Ensure build artifacts exist for LSP
           '';
         };
       });
+      checks = eachSystem (pkgs: {
+        inherit (self.packages.${pkgs.stdenv.hostPlatform.system}) default;
+      });
       formatter = eachSystem (pkgs: pkgs.nixpkgs-fmt);
     };
 }

lib/cli.ml

@@ -17,14 +17,20 @@ module Cli = struct
   type strategy =
     { installables : string list
     ; target_info : target_info
+    ; printcmd : bool
     }
 
   (** Positional URI arguments passed to the program via the command line. *)
   let uris = Arg.(value & pos_all dirpath [] & info [])
 
+  let printcmd =
+    let doc = "Print the command to stdout instead of executing it." in
+    Arg.(value & flag & info [ "printcmd" ] ~doc)
+  ;;
+
   (** Processes the args so that the main function knows what to do with them. *)
   let make_strategy =
-    let build original_args =
+    let build original_args printcmd =
       let installables, target_info =
         let default_installables = []
         and default_target =
@@ -81,9 +87,9 @@ module Cli = struct
              , { entrypoint = None; attribute = None; subshell_dir = Some subshell_dir } )
            | _ -> Uri.parse_targets_tr original_args, default_target)
       in
-      { installables; target_info }
+      { installables; target_info; printcmd }
     in
-    Term.(const build $ uris)
+    Term.(const build $ uris $ printcmd)
   ;;
 
   let cmd entrypoint =
@@ -104,6 +110,8 @@ module Cli = struct
       ; `P
           "If a single SOURCE is provided and it is a directory, ns switches into it by \
            default unless a TARGET_DIR is explicitly given."
+      ; `S Manpage.s_options
+      ; `S ""
       ; `S Manpage.s_common_options
       ; `S ""
       ; `S Manpage.s_examples

lib/cmd.ml

@@ -16,6 +16,9 @@ module Cmd = struct
     | args -> List.fold_left (fun cmd arg -> Cmd.add_arg cmd arg) cmd args
   ;;
 
+  (** Convert a command into a string *)
+  let to_string cmd = Cmd.to_string cmd
+
   (** Run a command
 
     Example:

ns.opam

@@ -1,6 +1,6 @@
 # This file is generated by dune, edit dune-project instead
 opam-version: "2.0"
-version: "0.4.0"
+version: "0.4.1"
 synopsis: "A unified interface for nix shell."
 description:
   "An intuitive nix shell interface that unifies the `nix shell`, `nix develop` and `nix-shell` commands."

test/dune

@@ -0,0 +1,14 @@
+;; Define the test stanza for dune test
+
+(test
+ (name test_ns)
+ (deps test_ns src/flake/flake.nix src/shell/shell.nix)
+ (flags (:standard)))
+
+;; Rule to compile the Rust test file into a binary
+
+(rule
+ (targets test_ns) ; the Dune target name
+ (deps test_ns.rs) ; path relative to this dune file
+ (action
+  (run rustc --test %{deps} -o %{targets} --allow warnings)))

test/src/flake/flake.nix

@@ -0,0 +1,12 @@
+{
+  inputs.nixpkgs.url = "github:nixos/nixpkgs?ref=nixos-unstable";
+  outputs = { self, nixpkgs }:
+    let
+      inherit (nixpkgs.lib) genAttrs;
+      inherit (nixpkgs.lib.systems) flakeExposed;
+      eachSystem = f: genAttrs flakeExposed (system: f (import nixpkgs { inherit system; }));
+    in
+    {
+      packages = eachSystem (pkgs: { default = pkgs.hello; });
+    };
+}

test/src/shell/shell.nix

@@ -0,0 +1,6 @@
+{ pkgs ? import <nixpkgs> { } }:
+pkgs.mkShell {
+  buildInputs = builtins.attrValues {
+    inherit (pkgs) hello;
+  };
+}