Attempting to package shef in nixpkgs, seeking support to understand failed build checks

[code-goat]

I've chosen to learn nix packaging by attempting to package shef for nixpkgs. Towards this, I'm curious if anyone might be able to support my process and help me diagnose what might be causing these preCheck failures when building shef?

Running phase: unpackPhase
@nix { "action": "setPhase", "phase": "unpackPhase" }
unpacking source archive /nix/store/qc4g29ixpjz6wbyvhfisbxdbv7g9gjk9-source
source root is source
Running phase: patchPhase
@nix { "action": "setPhase", "phase": "patchPhase" }
Running phase: updateAutotoolsGnuConfigScriptsPhase
@nix { "action": "setPhase", "phase": "updateAutotoolsGnuConfigScriptsPhase" }
Running phase: configurePhase
@nix { "action": "setPhase", "phase": "configurePhase" }
Running phase: buildPhase
@nix { "action": "setPhase", "phase": "buildPhase" }
Building subPackage .
Building subPackage ./internal
buildPhase completed in 1 minutes 4 seconds
Running phase: checkPhase
@nix { "action": "setPhase", "phase": "checkPhase" }
+++ return 0
+++ export 'GOFLAGS=-mod=vendor '
+++ GOFLAGS='-mod=vendor '
++++ getGoDirs test
++++ local type
++++ type=test
++++ '[' -n '' ']'
++++ find . -type f -name '*test.go' -exec dirname '{}' ';'
++++ grep -v /vendor/
++++ sort --unique
++++ grep -v '\(/_\|examples\|Godeps\|testdata\)'
+++ for pkg in $(getGoDirs test)
+++ buildGoDir test ./internal
+++ local cmd=test dir=./internal
+++ declare -a flags
+++ flags+=(${tags:+-tags=$(concatStringsSep "," tags)})
+++ flags+=(${ldflags:+-ldflags="${ldflags[*]}"})
+++ flags+=("-p" "$NIX_BUILD_CORES")
+++ ((  0 >= 1  ))
+++ '[' test = test ']'
+++ flags+=(-vet=off)
+++ flags+=($checkFlags)
+++ local OUT
++++ go test '-ldflags=-s -w -buildid=' -p 4 -vet=off ./internal
+++ OUT='--- FAIL: TestShefEndToEnd (0.00s)
    --- FAIL: TestShefEndToEnd/foreach_recipe (0.07s)
        testscript.go:584: # Set up home directory (0.000s)
            # Create recipe directory (0.000s)
            # Copy recipe file for testing (0.000s)
            # Test running the recipe (0.049s)
            # Validate test (0.000s)
            > stdout '\''apple'\''
            > stdout '\''banana'\''
            > stdout '\''cherry'\''
            > stdout '\''Processing apple'\''
            > stdout '\''Processing banana'\''
            FAIL: ../testdata/foreach_recipe.txtar:22: no match for `Processing banana` found in stdout
            
    --- FAIL: TestShefEndToEnd/complex_recipe (0.11s)
        testscript.go:584: # Set up home directory (0.000s)
            # Create recipe directory (0.000s)
            # Copy recipe file for testing (0.000s)
            # Test running the complex recipe (0.093s)
            # Validate test (0.000s)
            > stdout '\''Line 1'\''
            > stdout '\''Line 2'\''
            > stdout '\''Line 3'\''
            > stdout '\''Line 4'\''
            > stdout '\''Line 5'\''
            > stdout '\''Iteration 1'\''
            > stdout '\''Iteration 2'\''
            > stdout '\''Iteration 3'\''
            > stdout '\''File has more than 3 lines'\''
            FAIL: ../testdata/complex_recipe.txtar:26: no match for `File has more than 3 lines` found in stdout
            
    --- FAIL: TestShefEndToEnd/command_input_recipe (0.05s)
        testscript.go:584: # Set up home directory (0.000s)
            # Create recipe directory (0.000s)
            # Copy recipe file for testing (0.000s)
            # Test running the command input recipe (0.041s)
            # Validate test (0.000s)
            > stdout '\''line1'\''
            > stdout '\''line2'\''
            > stdout '\''line3'\''
            > stdout '\''Found: line2'\''
            FAIL: ../testdata/command_input_recipe.txtar:21: no match for `Found: line2` found in stdout
            
FAIL
FAIL	github.com/eduardoagarcia/shef/internal	4.162s
FAIL'
+++ echo '--- FAIL: TestShefEndToEnd (0.00s)
    --- FAIL: TestShefEndToEnd/foreach_recipe (0.07s)
        testscript.go:584: # Set up home directory (0.000s)
            # Create recipe directory (0.000s)
            # Copy recipe file for testing (0.000s)
            # Test running the recipe (0.049s)
            # Validate test (0.000s)
            > stdout '\''apple'\''
            > stdout '\''banana'\''
            > stdout '\''cherry'\''
            > stdout '\''Processing apple'\''
            > stdout '\''Processing banana'\''
            FAIL: ../testdata/foreach_recipe.txtar:22: no match for `Processing banana` found in stdout
            
    --- FAIL: TestShefEndToEnd/complex_recipe (0.11s)
        testscript.go:584: # Set up home directory (0.000s)
            # Create recipe directory (0.000s)
            # Copy recipe file for testing (0.000s)
            # Test running the complex recipe (0.093s)
            # Validate test (0.000s)
            > stdout '\''Line 1'\''
            > stdout '\''Line 2'\''
            > stdout '\''Line 3'\''
            > stdout '\''Line 4'\''
            > stdout '\''Line 5'\''
            > stdout '\''Iteration 1'\''
            > stdout '\''Iteration 2'\''
            > stdout '\''Iteration 3'\''
            > stdout '\''File has more than 3 lines'\''
            FAIL: ../testdata/complex_recipe.txtar:26: no match for `File has more than 3 lines` found in stdout
            
    --- FAIL: TestShefEndToEnd/command_input_recipe (0.05s)
        testscript.go:584: # Set up home directory (0.000s)
            # Create recipe directory (0.000s)
            # Copy recipe file for testing (0.000s)
            # Test running the command input recipe (0.041s)
            # Validate test (0.000s)
            > stdout '\''line1'\''
            > stdout '\''line2'\''
            > stdout '\''line3'\''
            > stdout '\''Found: line2'\''
            FAIL: ../testdata/command_input_recipe.txtar:21: no match for `Found: line2` found in stdout
            
FAIL
FAIL	github.com/eduardoagarcia/shef/internal	4.162s
FAIL'
+++ grep -qE '(no( buildable| non-test)?|build constraints exclude all) Go (source )?files'
+++ echo '--- FAIL: TestShefEndToEnd (0.00s)
    --- FAIL: TestShefEndToEnd/foreach_recipe (0.07s)
        testscript.go:584: # Set up home directory (0.000s)
            # Create recipe directory (0.000s)
            # Copy recipe file for testing (0.000s)
            # Test running the recipe (0.049s)
            # Validate test (0.000s)
            > stdout '\''apple'\''
            > stdout '\''banana'\''
            > stdout '\''cherry'\''
            > stdout '\''Processing apple'\''
            > stdout '\''Processing banana'\''
            FAIL: ../testdata/foreach_recipe.txtar:22: no match for `Processing banana` found in stdout
            
    --- FAIL: TestShefEndToEnd/complex_recipe (0.11s)
        testscript.go:584: # Set up home directory (0.000s)
            # Create recipe directory (0.000s)
            # Copy recipe file for testing (0.000s)
            # Test running the complex recipe (0.093s)
            # Validate test (0.000s)
            > stdout '\''Line 1'\''
            > stdout '\''Line 2'\''
            > stdout '\''Line 3'\''
            > stdout '\''Line 4'\''
            > stdout '\''Line 5'\''
            > stdout '\''Iteration 1'\''
            > stdout '\''Iteration 2'\''
            > stdout '\''Iteration 3'\''
            > stdout '\''File has more than 3 lines'\''
            FAIL: ../testdata/complex_recipe.txtar:26: no match for `File has more than 3 lines` found in stdout
            
    --- FAIL: TestShefEndToEnd/command_input_recipe (0.05s)
        testscript.go:584: # Set up home directory (0.000s)
            # Create recipe directory (0.000s)
            # Copy recipe file for testing (0.000s)
            # Test running the command input recipe (0.041s)
            # Validate test (0.000s)
            > stdout '\''line1'\''
            > stdout '\''line2'\''
            > stdout '\''line3'\''
            > stdout '\''Found: line2'\''
            FAIL: ../testdata/command_input_recipe.txtar:21: no match for `Found: line2` found in stdout
            
FAIL
FAIL	github.com/eduardoagarcia/shef/internal	4.162s
FAIL'
--- FAIL: TestShefEndToEnd (0.00s)
    --- FAIL: TestShefEndToEnd/foreach_recipe (0.07s)
        testscript.go:584: # Set up home directory (0.000s)
            # Create recipe directory (0.000s)
            # Copy recipe file for testing (0.000s)
            # Test running the recipe (0.049s)
            # Validate test (0.000s)
            > stdout 'apple'
            > stdout 'banana'
            > stdout 'cherry'
            > stdout 'Processing apple'
            > stdout 'Processing banana'
            FAIL: ../testdata/foreach_recipe.txtar:22: no match for `Processing banana` found in stdout
            
    --- FAIL: TestShefEndToEnd/complex_recipe (0.11s)
        testscript.go:584: # Set up home directory (0.000s)
            # Create recipe directory (0.000s)
            # Copy recipe file for testing (0.000s)
            # Test running the complex recipe (0.093s)
            # Validate test (0.000s)
            > stdout 'Line 1'
            > stdout 'Line 2'
            > stdout 'Line 3'
            > stdout 'Line 4'
            > stdout 'Line 5'
            > stdout 'Iteration 1'
            > stdout 'Iteration 2'
            > stdout 'Iteration 3'
            > stdout 'File has more than 3 lines'
            FAIL: ../testdata/complex_recipe.txtar:26: no match for `File has more than 3 lines` found in stdout
            
    --- FAIL: TestShefEndToEnd/command_input_recipe (0.05s)
        testscript.go:584: # Set up home directory (0.000s)
            # Create recipe directory (0.000s)
            # Copy recipe file for testing (0.000s)
            # Test running the command input recipe (0.041s)
            # Validate test (0.000s)
            > stdout 'line1'
            > stdout 'line2'
            > stdout 'line3'
            > stdout 'Found: line2'
            FAIL: ../testdata/command_input_recipe.txtar:21: no match for `Found: line2` found in stdout
            
FAIL
FAIL	github.com/eduardoagarcia/shef/internal	4.162s
FAIL
+++ return 1
+ exitHandler
+ exitCode=1
+ set +e
+ '[' -n '' ']'
+ ((  1 != 0  ))
+ runHook failureHook
+ local hookName=failureHook
+ shift
+ local 'hooksSlice=failureHooks[@]'
+ local hook
+ for hook in "_callImplicitHook 0 $hookName" ${!hooksSlice+"${!hooksSlice}"}
+ _logHook failureHook '_callImplicitHook 0 failureHook'
+ [[ -z 2 ]]
+ local hookKind=failureHook
+ local 'hookExpr=_callImplicitHook 0 failureHook'
+ shift 2
+ declare -F '_callImplicitHook 0 failureHook'
+ type -p '_callImplicitHook 0 failureHook'
+ [[ _callImplicitHook 0 failureHook != \_\c\a\l\l\I\m\p\l\i\c\i\t\H\o\o\k* ]]
+ _eval '_callImplicitHook 0 failureHook'
+ declare -F '_callImplicitHook 0 failureHook'
+ eval '_callImplicitHook 0 failureHook'
++ _callImplicitHook 0 failureHook
++ local def=0
++ local hookName=failureHook
++ declare -F failureHook
++ type -p failureHook
++ '[' -n '' ']'
++ return 0
+ return 0
+ '[' -n '' ']'
+ return 1

[eduardoagarcia]

hmm, seems like some of the TestShefEndToEnd tests are failing. Shef uses github.com/rogpeppe/go-internal/testscript to run test recipes found in testdata/ within the repo.

I'm curious why some of the tests are failing, but not all 🤔

Maybe try the following?

Add debug output to see what's happening:

checkPhase = ''
  ls -la ../testdata/  # Check if test files exist
  cat ../testdata/foreach_recipe.txtar  # Examine test file content
  GOFLAGS="-mod=vendor -v" go test ./internal  # More verbose test output
'';

Or test if a simple recipe works, which might indicate path issues:

checkPhase = ''
  mkdir -p $HOME/.config/shef/recipes
  echo 'echo "Hello World"' > $HOME/.config/shef/recipes/test.sh
  chmod +x $HOME/.config/shef/recipes/test.sh
  # Then run your normal tests
  GOFLAGS="-mod=vendor" go test ./internal
'';