feat: print jornalctl log before failure of WaitForLogMessage

.github/workflows/unit-testing.yml

@@ -4,6 +4,7 @@ name: Unit Testing
 on:
   pull_request:
     paths: 
+      - 'env/**'
       - 'utils/**'
       - 'go.*'
       - '.github/workflows/unit-testing.yml'

README.md

@@ -1,5 +1,7 @@
 # Matter Snap Testing
 
+[![Go Reference](https://pkg.go.dev/badge/github.com/canonical/matter-snap-testing.svg)](https://pkg.go.dev/github.com/canonical/matter-snap-testing)
+
 Utility package for testing Matter snaps in Go.
 
 Test the testing utils:

env/env.go

@@ -8,14 +8,14 @@ import (
 // Environment variables, used to override defaults
 const (
 	// Channel/Revision of the service snap (has default)
-	envSnapChannel = "SNAP_CHANNEL"
+	EnvSnapChannel = "SNAP_CHANNEL"
 
 	// Path to snap instead, used for testing a local snap instead of
 	// downloading from the store
-	envSnapPath = "SNAP_PATH"
+	EnvSnapPath = "SNAP_PATH"
 
 	// Toggle the teardown operations during tests (has default)
-	envTeardown = "TEARDOWN"
+	EnvTeardown = "TEARDOWN"
 )
 
 var (
@@ -47,15 +47,15 @@ func init() {
 // Read environment variables and perform type conversion/casting
 func loadEnvVars() {
 
-	if v := os.Getenv(envSnapChannel); v != "" {
+	if v := os.Getenv(EnvSnapChannel); v != "" {
 		snapChannel = v
 	}
 
-	if v := os.Getenv(envSnapPath); v != "" {
+	if v := os.Getenv(EnvSnapPath); v != "" {
 		snapPath = v
 	}
 
-	if v := os.Getenv(envTeardown); v != "" {
+	if v := os.Getenv(EnvTeardown); v != "" {
 		var err error
 		teardown, err = strconv.ParseBool(v)
 		if err != nil {

go.mod

@@ -2,7 +2,7 @@ module github.com/canonical/matter-snap-testing
 
 go 1.22.1
 
-require github.com/stretchr/testify v1.8.4
+require github.com/stretchr/testify v1.9.0
 
 require (
 	github.com/davecgh/go-spew v1.1.1 // indirect

go.sum

@@ -7,10 +7,8 @@ github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/stretchr/testify v1.8.3 h1:RP3t2pwF7cMEbC1dqtB6poj3niw/9gnV4Cjg5oW5gtY=
-github.com/stretchr/testify v1.8.3/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
-github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
-github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY=
 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=

utils/config.go

@@ -1,6 +1,7 @@
 package utils
 
 import (
+	"fmt"
 	"strings"
 	"testing"
 	"time"
@@ -9,7 +10,7 @@ import (
 )
 
 type Config struct {
-	TestAutoStart  bool
+	TestAutoStart bool
 }
 
 func TestConfig(t *testing.T, snapName string, conf Config) {
@@ -65,5 +66,9 @@ func WaitForLogMessage(t *testing.T, snap, expectedLog string, since time.Time)
 		}
 	}
 
-	t.Fatalf("Time out: reached max %d retries.", maxRetry)
+	t.Logf("Time out: reached max %d retries.", maxRetry)
+	stdout, _, _ := Exec(t,
+		fmt.Sprintf("sudo journalctl --lines=20 --no-pager --unit=snap.\"%s\" --priority=notice", snap))
+	t.Log(stdout)
+	t.FailNow()
 }