Does this one work?

pre-resleases

.github/workflows/automatic-prerelease.yml

@@ -0,0 +1,28 @@
+---
+name: "pre-release"
+
+on:
+  push:
+    branches:
+      - "main"
+
+jobs:
+  pre-release:
+    name: "Pre Release"
+    runs-on: "ubuntu-latest"
+
+    steps:
+      # ...
+      - name: "Build & test"
+        run: |
+          echo "done!"
+
+      - uses: "marvinpinto/action-automatic-releases@latest"
+        with:
+          repo_token: "${{ secrets.GITHUB_TOKEN }}"
+          automatic_release_tag: "latest"
+          prerelease: true
+          title: "Development Build"
+          files: |
+            LICENSE.txt
+            *.jar

.github/workflows/tagged-release.yml

@@ -0,0 +1,26 @@
+---
+name: "tagged-release"
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  tagged-release:
+    name: "Tagged Release"
+    runs-on: "ubuntu-latest"
+
+    steps:
+      # ...
+      - name: "Build & test"
+        run: |
+          echo "done!"
+
+      - uses: "marvinpinto/action-automatic-releases@latest"
+        with:
+          repo_token: "${{ secrets.GITHUB_TOKEN }}"
+          prerelease: false
+          files: |
+            LICENSE.txt
+            *.jar

assets/normal2.txt

@@ -0,0 +1,15 @@
+####### #######
+#   #       # #
+### # ##### # #
+#   #     #   #
+# ########### #
+#     #     # #
+### # # ##### #
+#   #   #   # #
+# ### ### # # #
+# #   #   #   #
+# ### # #######
+#   # # #     #
+# # ### ### # #
+# #         # #
+####### #######

go.mod

@@ -1,5 +1,15 @@
 module maze-solver
 
-go 1.20
+go 1.21
 
-require golang.org/x/exp v0.0.0-20230801115018-d63ba01acd4b
+require (
+	github.com/akamensky/argparse v1.4.0
+	github.com/mazznoer/colorgrad v0.9.1
+	golang.org/x/exp v0.0.0-20230801115018-d63ba01acd4b
+)
+
+require (
+	github.com/lucasb-eyer/go-colorful v1.2.0 // indirect
+	github.com/mazznoer/csscolorparser v0.1.2 // indirect
+	golang.org/x/image v0.11.0
+)

go.sum

@@ -1,2 +1,43 @@
+github.com/akamensky/argparse v1.4.0 h1:YGzvsTqCvbEZhL8zZu2AiA5nq805NZh75JNj4ajn1xc=
+github.com/akamensky/argparse v1.4.0/go.mod h1:S5kwC7IuDcEr5VeXtGPRVZ5o/FdhcMlQz4IZQuw64xA=
+github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY=
+github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
+github.com/mazznoer/colorgrad v0.9.1 h1:MB80JYVndKWSMEM1beNqnuOowWGhoQc3DXWXkFp6JlM=
+github.com/mazznoer/colorgrad v0.9.1/go.mod h1:WX2R9wt9B47+txJZVVpM9LY+LAGIdi4lTI5wIyreDH4=
+github.com/mazznoer/csscolorparser v0.1.2 h1:/UBHuQg792ePmGFzTQAC9u+XbFr7/HzP/Gj70Phyz2A=
+github.com/mazznoer/csscolorparser v0.1.2/go.mod h1:Aj22+L/rYN/Y6bj3bYqO3N6g1dtdHtGfQ32xZ5PJQic=
+github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
+golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
+golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
 golang.org/x/exp v0.0.0-20230801115018-d63ba01acd4b h1:r+vk0EmXNmekl0S0BascoeeoHk/L7wmaW2QF90K+kYI=
 golang.org/x/exp v0.0.0-20230801115018-d63ba01acd4b/go.mod h1:FXUEEKJgO7OQYeo8N01OfiKP8RXMtf6e8aTskBGqWdc=
+golang.org/x/image v0.11.0 h1:ds2RoQvBvYTiJkwpSFDwCcDFNX7DqjL2WsUgTNk0Ooo=
+golang.org/x/image v0.11.0/go.mod h1:bglhjqbqVuEb9e9+eNR45Jfu7D+T4Qan+NhQk8Ck2P8=
+golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
+golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
+golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
+golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
+golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
+golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=
+golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
+golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
+golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k=
+golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
+golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
+golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
+golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
+golang.org/x/text v0.12.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE=
+golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
+golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
+golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
+golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU=
+golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=

io/reader/image.go

@@ -1,9 +1,76 @@
 package reader
 
-import "maze-solver/maze"
+import (
+	"image"
+	"image/color"
+	"image/png"
+	"maze-solver/utils"
+	"os"
 
-type ImageReader struct{}
+	"golang.org/x/image/draw"
+)
 
-func (r *ImageReader) Read(filename string) (*maze.Maze, error) {
+type ImageReader struct {
-	return nil, nil
+	Filename              string
+	PathColor, WallColor  color.Color
+	CellWidth, CellHeight int
+}
+
+func (r *ImageReader) Read() (*RawMaze, error) {
+	defer utils.Timer("Image reader", 3)()
+	image, err := r.getShrunkImage()
+	if err != nil {
+		return nil, err
+	}
+
+	width, height := image.Bounds().Max.X, image.Bounds().Max.Y
+	ret := &RawMaze{
+		Width:  width,
+		Height: height,
+		Data:   make([][]byte, height),
+	}
+
+	n_chunks := width/CHUNK_SIZE + 1
+
+	for i := 0; i < height; i++ {
+		ret.Data[i] = make([]byte, n_chunks)
+	}
+
+	for y := 0; y < height; y++ {
+		for i := 0; i < n_chunks; i++ {
+			var chunk byte = 0 // all walls
+
+			end_index := min((i+1)*CHUNK_SIZE, width)
+
+			for x := i * CHUNK_SIZE; x < end_index; x++ {
+				c := image.At(x, y)
+				if c == r.PathColor {
+					chunk |= 1 << (CHUNK_SIZE - 1 - (x - i*CHUNK_SIZE))
+				}
+			}
+
+			ret.Data[y][i] = chunk
+		}
+	}
+
+	return ret, nil
+}
+
+func (r *ImageReader) getShrunkImage() (*image.RGBA, error) {
+	input, err := os.Open(r.Filename)
+	if err != nil {
+		return nil, err
+	}
+	defer input.Close()
+
+	// Decode the image (from PNG to image.Image):
+	src, _ := png.Decode(input)
+
+	// Set the expected size that you want:
+	dst := image.NewRGBA(image.Rect(0, 0, src.Bounds().Max.X/r.CellWidth, src.Bounds().Max.Y/r.CellHeight))
+
+	// Resize:
+	draw.NearestNeighbor.Scale(dst, dst.Rect, src, src.Bounds(), draw.Over, nil)
+
+	return dst, nil
 }

io/reader/image_test.go

@@ -0,0 +1,136 @@
+package reader
+
+import (
+	"image/color"
+	"maze-solver/utils"
+	"testing"
+)
+
+func TestImageReader(t *testing.T) {
+	white := color.RGBA{255, 255, 255, 255}
+	black := color.RGBA{0, 0, 0, 255}
+	tests := []struct {
+		name                  string
+		width, height         int
+		cellWidth, cellHeight int
+		pathColor, wallColor  color.Color
+		filename              string
+		expected              [][]byte
+	}{
+		{
+			"Trivial",
+			5, 3,
+			40, 40,
+			white, black,
+			"../../assets/trivial.png",
+			[][]byte{
+				{0b_00100_000},
+				{0b_01110_000},
+				{0b_00010_000},
+			},
+		},
+		{
+			"Trivial Bigger",
+			7, 5,
+			40, 40,
+			white, black,
+			"../../assets/trivial-bigger.png",
+			[][]byte{
+				{0b_0001000_0},
+				{0b_0001000_0},
+				{0b_0111110_0},
+				{0b_0000010_0},
+				{0b_0000010_0},
+			},
+		},
+		{
+			"Bigger Staggered",
+			7, 5,
+			40, 40,
+
+			white, black,
+			"../../assets/trivial-bigger-staggered.png",
+			[][]byte{
+				{0b_0001000_0},
+				{0b_0001000_0},
+				{0b_0111110_0},
+				{0b_0000100_0},
+				{0b_0000100_0},
+			},
+		},
+		{
+			"Normal",
+			11, 11,
+			40, 40,
+			white, black,
+			"../../assets/normal.png",
+			[][]byte{
+				{0b_00000100, 0b000_00000},
+				{0b_01111101, 0b110_00000},
+				{0b_00000100, 0b010_00000},
+				{0b_01110111, 0b110_00000},
+				{0b_01010000, 0b010_00000},
+				{0b_01011111, 0b110_00000},
+				{0b_00010001, 0b010_00000},
+				{0b_01110111, 0b010_00000},
+				{0b_01000000, 0b010_00000},
+				{0b_01111101, 0b110_00000},
+				{0b_00000100, 0b000_00000},
+			},
+		},
+		{
+			"Normal2",
+			15, 15,
+			20, 20,
+			white, black,
+			"../../assets/normal2.png",
+			[][]byte{
+				{0b00000001, 0b0000000_0},
+				{0b01110111, 0b1111010_0},
+				{0b00010100, 0b0001010_0},
+				{0b01110111, 0b1101110_0},
+				{0b01000000, 0b0000010_0},
+				{0b01111101, 0b1111010_0},
+				{0b00010101, 0b0000010_0},
+				{0b01110111, 0b0111010_0},
+				{0b01000100, 0b0101010_0},
+				{0b01011101, 0b1101110_0},
+				{0b01000101, 0b0000000_0},
+				{0b01110101, 0b0111110_0},
+				{0b01010001, 0b0001010_0},
+				{0b01011111, 0b1111010_0},
+				{0b00000001, 0b0000000_0},
+			},
+		},
+	}
+
+	for _, test := range tests {
+		reader := ImageReader{
+			Filename:   test.filename,
+			PathColor:  test.pathColor,
+			WallColor:  test.wallColor,
+			CellWidth:  test.cellWidth,
+			CellHeight: test.cellHeight,
+		}
+		got, err := reader.Read()
+		if err != nil {
+			t.Fatalf("%s: got error while reading, got\n%v", test.filename, err)
+		}
+
+		utils.AssertEqual(t, got.Width, test.width, "%s: width of raw maze don't match", test.name)
+		utils.AssertEqual(t, got.Height, test.height, "%s: height of raw maze don't match", test.name)
+		utils.AssertEqual(t, len(got.Data), len(test.expected), "%s: don't have the same number of rows", test.name)
+
+		for y, line_exp := range test.expected {
+			line_got := got.Data[y]
+			utils.AssertEqual(t, len(line_got), len(line_exp), "%s (line %v): don't have same number of chunks", test.name, y)
+
+			for i, chunk_exp := range line_exp {
+				chunk_got := line_got[i]
+				if chunk_got != chunk_exp {
+					t.Fatalf("%s (line %v): chunk %v don't coincide, %08b, want %08b", test.name, y, i, chunk_got, chunk_exp)
+				}
+			}
+		}
+	}
+}

io/reader/reader.go

@@ -1,5 +1,48 @@
 package reader
 
+import (
+	"fmt"
+	"image/color"
+)
+
 type Reader interface {
 	Read() (*RawMaze, error)
 }
+
+type ReaderFactory struct {
+	Type                             string
+	Filename                         *string
+	PathChar, WallChar, SolutionChar *string
+	CellWidth, CellHeight            *int
+	WallColor, PathColor             color.Color
+}
+
+const (
+	_IMAGE = "image"
+	_TEXT  = "text"
+)
+
+var TYPES = map[string]string{
+	".png": _IMAGE,
+	".txt": _TEXT,
+}
+
+func (f *ReaderFactory) Get() Reader {
+	switch f.Type {
+	case _TEXT:
+		return &TextReader{
+			Filename: *f.Filename,
+			PathChar: byte((*f.PathChar)[0]),
+			WallChar: byte((*f.WallChar)[0]),
+		}
+	case _IMAGE:
+		return &ImageReader{
+			Filename:   *f.Filename,
+			CellWidth:  *f.CellWidth,
+			CellHeight: *f.CellHeight,
+			WallColor:  f.WallColor,
+			PathColor:  f.PathColor,
+		}
+	}
+	panic(fmt.Sprintf("Unrecognized reader type %q", f.Type))
+}

io/reader/strings.go

@@ -11,6 +11,7 @@ type StringsReader struct {
 }
 
 func (r *StringsReader) Read() (*RawMaze, error) {
+	defer utils.Timer("Strings Reader", 3)()
 	width, height := len((*r.Lines)[0]), len(*r.Lines)
 	ret := &RawMaze{
 		Width:  width,

io/reader/strings_test.go

@@ -1,6 +1,7 @@
 package reader
 
 import (
+	"maze-solver/utils"
 	"testing"
 )
 
@@ -111,13 +112,13 @@ func TestStringsReader(t *testing.T) {
 		}
 		got, _ := reader.Read()
 
-		assertEqual(t, got.Width, test.width, "%s: width of raw maze don't match", test.name)
+		utils.AssertEqual(t, got.Width, test.width, "%s: width of raw maze don't match", test.name)
-		assertEqual(t, got.Height, test.height, "%s: height of raw maze don't match", test.name)
+		utils.AssertEqual(t, got.Height, test.height, "%s: height of raw maze don't match", test.name)
-		assertEqual(t, len(got.Data), len(test.expected), "%s: don't have the same number of rows", test.name)
+		utils.AssertEqual(t, len(got.Data), len(test.expected), "%s: don't have the same number of rows", test.name)
 
 		for y, line_exp := range test.expected {
 			line_got := got.Data[y]
-			assertEqual(t, len(line_got), len(line_exp), "%s (line %v): don't have same number of chunks, %v, want %v", test.name, y)
+			utils.AssertEqual(t, len(line_got), len(line_exp), "%s (line %v): don't have same number of chunks, %v, want %v", test.name, y)
 
 			for i, chunk_exp := range line_exp {
 				chunk_got := line_got[i]
@@ -128,10 +129,3 @@ func TestStringsReader(t *testing.T) {
 		}
 	}
 }
-
-func assertEqual[T comparable](t *testing.T, got T, want T, msg string, args ...any) {
-	args = append(args, got, want)
-	if got != want {
-		t.Fatalf(msg+"\nGot: %v, Want: %v", args...)
-	}
-}

io/reader/text.go

@@ -2,6 +2,7 @@ package reader
 
 import (
 	"bufio"
+	"maze-solver/utils"
 	"os"
 )
 
@@ -10,7 +11,8 @@ type TextReader struct {
 	PathChar, WallChar byte
 }
 
-func (r TextReader) Read() (*RawMaze, error) {
+func (r *TextReader) Read() (*RawMaze, error) {
+	defer utils.Timer("Text Reader", 3)()
 	lines, err := getLines(r.Filename)
 	if err != nil {
 		return nil, err

io/reader/text_test.go

@@ -1,108 +1,105 @@
 package reader
 
 import (
-	// "maze-solver/maze"
+	"maze-solver/utils"
-	// "maze-solver/utils"
+	"reflect"
-	// "reflect"
 	"testing"
 )
 
 func TestTextReadTrivial(t *testing.T) {
-	/*
+	tests := []struct {
-		tests := []struct {
+		name     string
-			name     string
+		filename string
-			filename string
+		pathChar byte
-			pathChar byte
+		wallChar byte
-			wallChar byte
+		expected *RawMaze
-			expected *maze.RawMaze
+	}{
-		}{
+		{
-			{
+			"Trivial",
-				"Trivial",
+			"../../assets/trivial.txt",
-				"../../assets/trivial.txt",
+			' ',
-				' ',
+			'#',
-				'#',
+			&RawMaze{
-				&maze.RawMaze{
+				Width:  5,
-					PathChar: ' ',
+				Height: 3,
-					WallChar: '#',
+				Data: [][]byte{
-					Data: []string{
+					{0b_00100_000},
-						"## ##",
+					{0b_01110_000},
-						"#   #",
+					{0b_00010_000},
-						"### #",
-					},
 				},
 			},
-			{
+		},
-				"Trivial Bigger",
+		{
-				"../../assets/trivial-bigger.txt",
+			"Trivial Bigger",
-				' ',
+			"../../assets/trivial-bigger.txt",
-				'#',
+			' ',
-				&maze.RawMaze{
+			'#',
-					PathChar: ' ',
+			&RawMaze{
-					WallChar: '#',
+				Width:  7,
-					Data: []string{
+				Height: 5,
-						"### ###",
+				Data: [][]byte{
-						"### ###",
+					{0b_0001000_0},
-						"#     #",
+					{0b_0001000_0},
-						"##### #",
+					{0b_0111110_0},
-						"##### #",
+					{0b_0000010_0},
-					},
+					{0b_0000010_0},
 				},
 			},
-			{
+		},
-				"Bigger Staggered",
+		{
-				"../../assets/trivial-bigger-staggered.txt",
+			"Bigger Staggered",
-				' ',
+			"../../assets/trivial-bigger-staggered.txt",
-				'#',
+			' ',
-				&maze.RawMaze{
+			'#',
-					PathChar: ' ',
+			&RawMaze{
-					WallChar: '#',
+				Width:  7,
-					Data: []string{
+				Height: 5,
-						"### ###",
+				Data: [][]byte{
-						"### ###",
+					{0b_0001000_0},
-						"#     #",
+					{0b_0001000_0},
-						"#### ##",
+					{0b_0111110_0},
-						"#### ##",
+					{0b_0000100_0},
-					},
+					{0b_0000100_0},
 				},
 			},
-			{
+		},
-				"Normal",
+		{
-				"../../assets/normal.txt",
+			"Normal",
-				' ',
+			"../../assets/normal.txt",
-				'#',
+			' ',
-				&maze.RawMaze{
+			'#',
-					PathChar: ' ',
+			&RawMaze{
-					WallChar: '#',
+				Width:  11,
-					Data: []string{
+				Height: 11,
-						"##### #####",
+				Data: [][]byte{
-						"#     #   #",
+					{0b_00000100, 0b000_00000},
-						"##### ### #",
+					{0b_01111101, 0b110_00000},
-						"#   #     #",
+					{0b_00000100, 0b010_00000},
-						"# # ##### #",
+					{0b_01110111, 0b110_00000},
-						"# #       #",
+					{0b_01010000, 0b010_00000},
-						"### ### # #",
+					{0b_01011111, 0b110_00000},
-						"#   #   # #",
+					{0b_00010001, 0b010_00000},
-						"# ####### #",
+					{0b_01110111, 0b010_00000},
-						"#     #   #",
+					{0b_01000000, 0b010_00000},
-						"##### #####",
+					{0b_01111101, 0b110_00000},
-					},
+					{0b_00000100, 0b000_00000},
 				},
 			},
+		},
+	}
+
+	for _, test := range tests {
+		reader := TextReader{
+			Filename: test.filename,
+			PathChar: test.pathChar,
+			WallChar: test.wallChar,
 		}
 
-		for _, test := range tests {
+		got, err := reader.Read()
-			reader := TextReader{
+		utils.Check(err, "Couldn't read file %q", reader.Filename)
-				Filename: test.filename,
-				PathChar: test.pathChar,
-				WallChar: test.wallChar,
-			}
 
-			got, err := reader.Read()
+		if !reflect.DeepEqual(got, test.expected) {
-			utils.Check(err, "Couldn't read file %q", reader.Filename)
+			t.Fatalf("%s: lexed mazes do not match\nGot: %v\nWant: %v", test.name, got, test.expected)
-
-			if !reflect.DeepEqual(got, test.expected) {
-				t.Fatalf("%s: lexed mazes do not match\nGot: %v\nWant: %v", test.name, got, test.expected)
-			}
 		}
-	*/
+	}
 }

io/writer/image.go

@@ -1,11 +1,123 @@
 package writer
 
 import (
+	"errors"
+	"image"
+	"image/color"
+	"image/draw"
+	"image/png"
 	"maze-solver/maze"
+	"maze-solver/utils"
+	"os"
+
+	"github.com/mazznoer/colorgrad"
 )
 
-type ImageWriter struct{}
+type ImageWriter struct {
+	Filename              string
+	Maze                  *maze.SolvedMaze
+	CellWidth, CellHeight int
+	WallColor, PathColor  color.Color
+	SolutionGradient      colorgrad.Gradient
+	img                   *image.RGBA
+}
 
-func (w *ImageWriter) Write(filename string, maze *maze.SolvedMaze) error {
+func (w *ImageWriter) Write() error {
+	defer utils.Timer("Image writer", 3)()
+	if w.Filename[len(w.Filename)-4:] != ".png" {
+		return errors.New("Filename of ImageWriter doesn't have .png extension. The only suppported image type is png")
+	}
+
+	w.img = image.NewRGBA(image.Rect(0, 0, w.Maze.Width*w.CellWidth, w.Maze.Height*w.CellHeight))
+
+	// Fill the image with walls
+	draw.Draw(w.img, w.img.Bounds(), &image.Uniform{w.WallColor}, image.Pt(0, 0), draw.Src)
+
+	// Fill in the paths
+	var x0, y0, width, height int
+	for _, node := range w.Maze.Nodes {
+		x0 = node.Coords.X * w.CellWidth
+		y0 = node.Coords.Y * w.CellHeight
+		if node.Right != nil {
+			width = (node.Right.Coords.X - node.Coords.X + 1) * w.CellWidth
+			height = w.CellHeight
+			w.draw(x0, y0, width, height, w.PathColor)
+		}
+
+		if node.Down != nil {
+			width = w.CellWidth
+			height = (node.Down.Coords.Y - node.Coords.Y + 1) * w.CellHeight
+			w.draw(x0, y0, width, height, w.PathColor)
+		}
+	}
+
+	// Fill in the solution
+	total_len := w.getSolutionLength()
+	colors := w.SolutionGradient.Colors(uint(total_len + 1))
+	c := 0
+	width, height = w.CellWidth, w.CellHeight
+	for i, from := range w.Maze.Solution[:len(w.Maze.Solution)-1] {
+		to := w.Maze.Solution[i+1]
+
+		if from.Coords.X == to.Coords.X {
+			// Fill verticallly
+			x0 = from.Coords.X * w.CellWidth
+
+			if from.Coords.Y < to.Coords.Y {
+				for y := from.Coords.Y; y < to.Coords.Y; y++ {
+					y0 = y * w.CellHeight
+					w.draw(x0, y0, width, height, colors[c])
+					c++
+				}
+			} else {
+				for y := from.Coords.Y; y > to.Coords.Y; y-- {
+					y0 = y * w.CellHeight
+					w.draw(x0, y0, width, height, colors[c])
+					c++
+				}
+			}
+			y0 = to.Coords.Y * w.CellHeight
+			w.draw(x0, y0, width, height, colors[c])
+		} else {
+			// Fill horizontally
+			y0 = from.Coords.Y * w.CellHeight
+
+			if from.Coords.X < to.Coords.X {
+				for x := from.Coords.X; x < to.Coords.X; x++ {
+					x0 = x * w.CellWidth
+					w.draw(x0, y0, width, height, colors[c])
+					c++
+				}
+			} else {
+				for x := from.Coords.X; x > to.Coords.X; x-- {
+					x0 = x * w.CellWidth
+					w.draw(x0, y0, width, height, colors[c])
+					c++
+				}
+			}
+			x0 = to.Coords.X * w.CellWidth
+			w.draw(x0, y0, width, height, colors[c])
+		}
+	}
+
+	f, err := os.Create(w.Filename)
+	if err != nil {
+		return err
+	}
+	png.Encode(f, w.img)
+	f.Close()
 	return nil
 }
+
+func (w *ImageWriter) getSolutionLength() int {
+	ret := 0
+	for i, node := range w.Maze.Solution[:len(w.Maze.Solution)-1] {
+		next := w.Maze.Solution[i+1]
+		ret += int(node.Coords.Distance(next.Coords))
+	}
+	return ret
+}
+
+func (w *ImageWriter) draw(x0, y0, width, height int, color color.Color) {
+	draw.Draw(w.img, image.Rect(x0, y0, x0+width, y0+height), &image.Uniform{color}, image.Pt(0, 0), draw.Src)
+}

io/writer/image_test.go

@@ -0,0 +1,75 @@
+package writer
+
+import (
+	"image/color"
+	"maze-solver/maze"
+	"testing"
+
+	"github.com/mazznoer/colorgrad"
+)
+
+func TestImageWriter(t *testing.T) {
+	pathGradient, err := colorgrad.NewGradient().Colors(color.White).Build()
+	if err != nil {
+		panic(err)
+	}
+
+	tests := []struct {
+		name                  string
+		filename              string
+		m                     *maze.SolvedMaze
+		CellWidth, cellHeight int
+		pathColor, wallColor  color.Color
+		gradient              colorgrad.Gradient
+	}{
+		{
+			"Trivial",
+			"../../out/trivial_sol.png",
+			trivial(),
+			40, 40,
+			color.White, color.Black,
+			colorgrad.Warm(),
+		},
+		{
+			"Bigger",
+			"../../out/bigger_sol.png",
+			bigger(),
+			40, 40,
+			color.White, color.Black,
+			colorgrad.Warm(),
+		},
+		{
+			"Bigger Staggered",
+			"../../out/bigger_staggered_sol.png",
+			bigger_staggered(),
+			40, 40,
+			color.White, color.Black,
+			pathGradient,
+		},
+		{
+			"Normal",
+			"../../out/normal_sol.png",
+			normal(),
+			40, 40,
+			color.White, color.Black,
+			colorgrad.Warm(),
+		},
+	}
+
+	for _, test := range tests {
+		writer := ImageWriter{
+			Filename:         test.filename,
+			Maze:             test.m,
+			CellWidth:        test.CellWidth,
+			CellHeight:       test.cellHeight,
+			WallColor:        test.wallColor,
+			PathColor:        test.pathColor,
+			SolutionGradient: test.gradient,
+		}
+
+		err := writer.Write()
+		if err != nil {
+			t.Fatalf("%s: couldn't write solution, got following error\n%v", test.name, err)
+		}
+	}
+}

io/writer/strings.go

@@ -0,0 +1,77 @@
+package writer
+
+import (
+	"bytes"
+	"fmt"
+	"maze-solver/maze"
+	"maze-solver/utils"
+)
+
+type StringsWriter struct {
+	PathChar, WallChar byte
+	SolutionChar       byte
+	Maze               *maze.SolvedMaze
+	lines              [][]byte
+}
+
+func (w *StringsWriter) Write() error {
+	defer utils.Timer("Strings writer", 3)()
+	w.lines = make([][]byte, w.Maze.Height)
+
+	// Fill the lines with walls
+	for y := 0; y < w.Maze.Height; y++ {
+		w.lines[y] = bytes.Repeat([]byte{w.WallChar}, w.Maze.Width)
+	}
+
+	// Fill in the paths
+	for _, node := range w.Maze.Nodes {
+		if node.Right != nil {
+			w.fillHorizontally(node.Coords, node.Right.Coords, w.PathChar)
+		}
+		if node.Down != nil {
+			w.fillVertically(node.Coords, node.Down.Coords, w.PathChar)
+		}
+	}
+
+	// Fill in the solution
+	for i := 0; i < len(w.Maze.Solution)-1; i++ {
+		current := w.Maze.Solution[i].Coords
+		next := w.Maze.Solution[i+1].Coords
+
+		if current.X == next.X {
+			w.fillVertically(current, next, w.SolutionChar)
+		} else {
+			w.fillHorizontally(current, next, w.SolutionChar)
+		}
+	}
+
+	return nil
+}
+
+func (w *StringsWriter) fillHorizontally(from maze.Coordinates, to maze.Coordinates, char byte) {
+	y := from.Y
+	if from.X > to.X {
+		from, to = to, from
+	}
+	for x := from.X; x <= to.X; x++ {
+		w.lines[y][x] = char
+	}
+}
+
+func (w *StringsWriter) fillVertically(from maze.Coordinates, to maze.Coordinates, char byte) {
+	x := from.X
+	if from.Y > to.Y {
+		from, to = to, from
+	}
+	for y := from.Y; y <= to.Y; y++ {
+		w.lines[y][x] = char
+	}
+}
+
+func (w *StringsWriter) GetLines() []string {
+	ret := make([]string, len(w.lines))
+	for i, line := range w.lines {
+		ret[i] = fmt.Sprint(string(line))
+	}
+	return ret
+}

io/writer/strings_test.go

@@ -0,0 +1,88 @@
+package writer
+
+import (
+	"fmt"
+	"maze-solver/maze"
+	"maze-solver/utils"
+	"testing"
+)
+
+func TestStringsWriter(t *testing.T) {
+	tests := []struct {
+		name                             string
+		m                                *maze.SolvedMaze
+		pathChar, wallChar, solutionChar byte
+		expected                         []string
+	}{
+		{
+			"Trivial",
+			trivial(),
+			' ', '#', '.',
+			[]string{
+				"##.##",
+				"# ..#",
+				"###.#",
+			},
+		},
+		{
+			"Bigger",
+			bigger(),
+			'_', '~', '*',
+			[]string{
+				"~~~*~~~",
+				"~~~*~~~",
+				"~__***~",
+				"~~~~~*~",
+				"~~~~~*~",
+			},
+		},
+		{
+			"Bigger Staggered",
+			bigger_staggered(),
+			' ', '#', '.',
+			[]string{
+				"###.###",
+				"###.###",
+				"#  .. #",
+				"####.##",
+				"####.##",
+			},
+		},
+		{
+			"Normal",
+			normal(),
+			' ', '#', '.',
+			[]string{
+				"#####.#####",
+				"#    .#   #",
+				"#####.### #",
+				"#   #.....#",
+				"# # #####.#",
+				"# #.......#",
+				"###.### # #",
+				"#...#   # #",
+				"#.####### #",
+				"#.....#   #",
+				"#####.#####",
+			},
+		},
+	}
+
+	for _, test := range tests {
+		fmt.Printf("----------- %s -----------\n", test.name)
+		writer := StringsWriter{
+			PathChar:     test.pathChar,
+			WallChar:     test.wallChar,
+			SolutionChar: test.solutionChar,
+			Maze:         test.m,
+		}
+		writer.Write()
+		got := writer.GetLines()
+
+		utils.AssertEqual(t, len(got), len(test.expected), "%s: different amount of lines.", test.name)
+
+		for i, line := range test.expected {
+			utils.AssertEqual(t, got[i], line, "%s, line %v: not what we expected.", test.name, i)
+		}
+	}
+}

io/writer/utils.go

@@ -0,0 +1,291 @@
+package writer
+
+import "maze-solver/maze"
+
+func trivial() *maze.SolvedMaze {
+	/* trivial.txt
+	   ## ##
+	   #   #
+	   ### #
+
+	   Nodes are
+	   ##0##
+	   #123#
+	   ###4#
+	*/
+	nodes := make([]*maze.Node, 5)
+
+	nodes[0] = maze.NewNode(maze.Coordinates{X: 2, Y: 0})
+
+	nodes[1] = maze.NewNode(maze.Coordinates{X: 1, Y: 1})
+	nodes[2] = maze.NewNode(maze.Coordinates{X: 2, Y: 1})
+	nodes[3] = maze.NewNode(maze.Coordinates{X: 3, Y: 1})
+
+	nodes[4] = maze.NewNode(maze.Coordinates{X: 3, Y: 2})
+
+	nodes[0].Down = nodes[2]
+
+	nodes[1].Right = nodes[2]
+
+	nodes[2].Up = nodes[0]
+	nodes[2].Left = nodes[1]
+	nodes[2].Right = nodes[3]
+
+	nodes[3].Left = nodes[2]
+	nodes[3].Down = nodes[4]
+
+	nodes[4].Up = nodes[3]
+
+	ret := &maze.SolvedMaze{
+		Maze: &maze.Maze{
+			Width:  5,
+			Height: 3,
+			Nodes:  nodes,
+		},
+		Solution: []*maze.Node{
+			nodes[0], nodes[2], nodes[3], nodes[4],
+		},
+	}
+
+	return ret
+}
+
+func bigger() *maze.SolvedMaze {
+	/* trivial-bigger.txt
+	   ### ###
+	   ### ###
+	   #     #
+	   ##### #
+	   ##### #
+
+	   Nodes are
+	   ###0###
+	   ### ###
+	   #1 2 3#
+	   ##### #
+	   #####4#
+	*/
+	nodes := make([]*maze.Node, 5)
+
+	nodes[0] = maze.NewNode(maze.Coordinates{X: 3, Y: 0})
+
+	nodes[1] = maze.NewNode(maze.Coordinates{X: 1, Y: 2})
+	nodes[2] = maze.NewNode(maze.Coordinates{X: 3, Y: 2})
+	nodes[3] = maze.NewNode(maze.Coordinates{X: 5, Y: 2})
+
+	nodes[4] = maze.NewNode(maze.Coordinates{X: 5, Y: 4})
+
+	nodes[0].Down = nodes[2]
+
+	nodes[1].Right = nodes[2]
+
+	nodes[2].Up = nodes[0]
+	nodes[2].Left = nodes[1]
+	nodes[2].Right = nodes[3]
+
+	nodes[3].Left = nodes[2]
+	nodes[3].Down = nodes[4]
+
+	nodes[4].Up = nodes[3]
+
+	ret := &maze.SolvedMaze{
+		Maze: &maze.Maze{
+			Width:  7,
+			Height: 5,
+			Nodes:  nodes,
+		},
+		Solution: []*maze.Node{
+			nodes[0], nodes[2], nodes[3], nodes[4],
+		},
+	}
+
+	return ret
+}
+
+func bigger_staggered() *maze.SolvedMaze {
+	/* trivial-bigger-staggered.txt
+	   ### ###
+	   ### ###
+	   #     #
+	   #### ##
+	   #### ##
+
+	   Nodes are
+	   ###0###
+	   ### ###
+	   #1 243#
+	   #### ##
+	   ####5##
+	*/
+	nodes := make([]*maze.Node, 6)
+
+	nodes[0] = maze.NewNode(maze.Coordinates{X: 3, Y: 0})
+
+	nodes[1] = maze.NewNode(maze.Coordinates{X: 1, Y: 2})
+	nodes[2] = maze.NewNode(maze.Coordinates{X: 3, Y: 2})
+	nodes[3] = maze.NewNode(maze.Coordinates{X: 5, Y: 2})
+
+	nodes[4] = maze.NewNode(maze.Coordinates{X: 4, Y: 2})
+
+	nodes[5] = maze.NewNode(maze.Coordinates{X: 4, Y: 4})
+
+	nodes[0].Down = nodes[2]
+
+	nodes[1].Right = nodes[2]
+
+	nodes[2].Up = nodes[0]
+	nodes[2].Left = nodes[1]
+	nodes[2].Right = nodes[4]
+
+	nodes[3].Left = nodes[4]
+
+	nodes[4].Left = nodes[2]
+	nodes[4].Right = nodes[3]
+	nodes[4].Down = nodes[5]
+
+	nodes[5].Up = nodes[4]
+
+	ret := &maze.SolvedMaze{
+		Maze: &maze.Maze{
+			Width:  7,
+			Height: 5,
+			Nodes:  nodes,
+		},
+		Solution: []*maze.Node{
+			nodes[0], nodes[2], nodes[4], nodes[5],
+		},
+	}
+
+	return ret
+}
+
+func normal() *maze.SolvedMaze {
+	/* normal.txt
+		##### #####
+		#     #   #
+		##### ### #
+		#   #     #
+		# # ##### #
+		# #       #
+		### ### # #
+		#   #   # #
+		# ####### #
+		#     #   #
+		##### #####
+
+	    Nodes are
+		#####0#####
+		#1   2#3 4#
+		##### ### #
+		#5 6#7   8#
+		# # ##### #
+		#9#A   F B#
+		### ### # #
+		#C D#E G# #
+		# ####### #
+		#H   I#J K#
+		#####L#####
+	*/
+	nodes := make([]*maze.Node, 22)
+
+	// ---- Node creation ----
+	coords := []struct{ x, y int }{
+		{5, 0}, // 0
+
+		{1, 1}, // 1
+		{5, 1}, // 2
+		{7, 1}, // 3
+		{9, 1}, // 4
+
+		{1, 3}, // 5
+		{3, 3}, // 6
+		{5, 3}, // 7
+		{9, 3}, // 8
+
+		{1, 5}, // 9
+		{3, 5}, // A (10)
+		{9, 5}, // B (11)
+
+		{1, 7}, // C (12)
+		{3, 7}, // D (13)
+		{5, 7}, // E (14)
+		{7, 5}, // F (15)
+		{7, 7}, // G (16)
+
+		{1, 9}, // H (17)
+		{5, 9}, // I (18)
+		{7, 9}, // J (19)
+		{9, 9}, // K (20)
+
+		{5, 10}, // L (21)
+	}
+
+	for i, coord := range coords {
+		nodes[i] = maze.NewNode(maze.Coordinates{X: coord.x, Y: coord.y})
+	}
+
+	// ---- Node linking ----
+	// Vertical
+	links := []struct {
+		from, to int
+	}{
+		{0, 2},
+		{2, 7},
+		{4, 8},
+		{5, 9},
+		{6, 10},
+		{8, 11},
+		{10, 13},
+		{15, 16},
+		{11, 20},
+		{12, 17},
+		{18, 21},
+	}
+	for _, link := range links {
+		nodes[link.from].Down = nodes[link.to]
+		nodes[link.to].Up = nodes[link.from]
+	}
+
+	links = []struct {
+		from, to int
+	}{
+		{1, 2},
+		{3, 4},
+		{5, 6},
+		{7, 8},
+		{10, 15},
+		{15, 11},
+		{12, 13},
+		{14, 16},
+		{17, 18},
+		{19, 20},
+	}
+	for _, link := range links {
+		nodes[link.from].Right = nodes[link.to]
+		nodes[link.to].Left = nodes[link.from]
+	}
+
+	ret := &maze.SolvedMaze{
+		Maze: &maze.Maze{
+			Width:  11,
+			Height: 11,
+			Nodes:  nodes,
+		},
+		Solution: []*maze.Node{
+			nodes[0],
+			nodes[2],
+			nodes[7],
+			nodes[8],
+			nodes[11],
+			nodes[15],
+			nodes[10],
+			nodes[13],
+			nodes[12],
+			nodes[17],
+			nodes[18],
+			nodes[21],
+		},
+	}
+
+	return ret
+}

io/writer/writer.go

@@ -1,7 +1,46 @@
 package writer
 
-import "maze-solver/maze"
+import (
+	"fmt"
+	"image/color"
+	"maze-solver/maze"
+
+	"github.com/mazznoer/colorgrad"
+)
 
 type Writer interface {
-	Write(filename string, maze *maze.SolvedMaze) error
+	Write() error
+}
+
+type WriterFactory struct {
+	Type                             string
+	Filename                         *string
+	PathChar, WallChar, SolutionChar *string
+	CellWidth, CellHeight            *int
+	WallColor, PathColor             color.Color
+	SolutionGradient                 colorgrad.Gradient
+}
+
+const (
+	_IMAGE = "image"
+)
+
+var TYPES = map[string]string{
+	".png": _IMAGE,
+}
+
+func (f *WriterFactory) Get(m *maze.SolvedMaze) Writer {
+	switch f.Type {
+	case _IMAGE:
+		return &ImageWriter{
+			Filename:         *f.Filename,
+			Maze:             m,
+			CellWidth:        *f.CellWidth,
+			CellHeight:       *f.CellHeight,
+			WallColor:        f.WallColor,
+			PathColor:        f.PathColor,
+			SolutionGradient: f.SolutionGradient,
+		}
+	}
+	panic(fmt.Sprintf("Unrecognized writer type %q", f.Type))
 }

main.go

@@ -1,25 +1,163 @@
 package main
 
 import (
+	"errors"
+	"fmt"
+	"image/color"
 	"maze-solver/io/reader"
 	"maze-solver/io/writer"
 	"maze-solver/maze/parser"
 	"maze-solver/solver"
 	"maze-solver/utils"
+	"os"
+	"strings"
+
+	"github.com/akamensky/argparse"
+	"github.com/mazznoer/colorgrad"
 )
 
 func main() {
-	output := "filename"
+	readerFactory, writerFactory, solverFactory, ok := parse_arguments()
 
-	reader := &reader.TextReader{Filename: "filename", PathChar: ' ', WallChar: '#'}
+	if !ok {
-	writer := &writer.ImageWriter{}
+		return
+	}
 
-	solver := &solver.Bfs{}
+	defer utils.Timer("TOTAL", 1)()
+	reader := readerFactory.Get()
 
 	maze, err := parser.Parse(reader)
-	utils.Check(err, "Couldn't read maze from %q", reader.Filename)
+	utils.Check(err, "Couldn't read maze")
 
+	solver := solverFactory.Get()
 	solved := solver.Solve(maze)
-	err = writer.Write(output, solved)
+
-	utils.Check(err, "Couldn't write solved maze to %q", output)
+	writer := writerFactory.Get(solved)
+
+	err = writer.Write()
+	utils.Check(err, "Couldn't write solved maze")
+}
+
+func parse_arguments() (*reader.ReaderFactory, *writer.WriterFactory, *solver.SolverFactory, bool) {
+	argparser := argparse.NewParser("maze-solver", "Solves the given maze (insane, right? who would've guessed?)")
+
+	var verboseLevel *int = argparser.FlagCounter("v", "verbose", &argparse.Options{
+		Help: `Verbose level of the solver
+        0: nothing printed to stdout
+        1: print the total time taken by the solver (time of the main() function)
+        2: prints the time the solving algorithm took to run
+        3: prints the time taken by each section (reader, solving algorithm, writer)`,
+	})
+
+	readerFactory := reader.ReaderFactory{}
+	writerFactory := writer.WriterFactory{}
+	solverFactory := solver.SolverFactory{}
+
+	readerFactory.Type = reader.TYPES[".png"]
+	readerFactory.Filename = argparser.String("i", "input", &argparse.Options{
+		Help:    "Input file",
+		Default: "maze.png",
+		Validate: func(args []string) error {
+			var ok bool
+			extension := args[0][len(args[0])-4:]
+			readerFactory.Type, ok = reader.TYPES[extension]
+			if ok {
+				return nil
+			} else {
+				return errors.New(fmt.Sprintf("Filetype not recognized %q", extension))
+			}
+		},
+	})
+
+	writerFactory.Type = writer.TYPES[".png"]
+	writerFactory.Filename = argparser.String("o", "output", &argparse.Options{
+		Help:    "Input file",
+		Default: "maze_sol.png",
+		Validate: func(args []string) error {
+			var ok bool
+			extension := args[0][len(args[0])-4:]
+			writerFactory.Type, ok = writer.TYPES[extension]
+			if ok {
+				return nil
+			} else {
+				return errors.New(fmt.Sprintf("Filetype not recognized %q", extension))
+			}
+		},
+	})
+
+	readerFactory.PathChar = argparser.String("", "path-char-in", &argparse.Options{
+		Help:    "Character to represent the path in a input text file",
+		Default: " ",
+		Validate: func(args []string) error {
+			if len(args[0]) > 1 {
+				return errors.New("Character must a string of length 1")
+			}
+			return nil
+		},
+	})
+
+	readerFactory.WallChar = argparser.String("", "wall-char-in", &argparse.Options{
+		Help:    "Character to represent the wall in a input text file",
+		Default: "#",
+		Validate: func(args []string) error {
+			if len(args[0]) > 1 {
+				return errors.New("Character must a string of length 1")
+			}
+			return nil
+		},
+	})
+
+	writerFactory.PathChar = argparser.String("", "path-char-out", &argparse.Options{
+		Help:    "Character to represent the path in a output text file",
+		Default: " ",
+		Validate: func(args []string) error {
+			if len(args[0]) > 1 {
+				return errors.New("Character must a string of length 1")
+			}
+			return nil
+		},
+	})
+
+	writerFactory.WallChar = argparser.String("", "wall-char-out", &argparse.Options{
+		Help:    "Character to represent the wall in a output text file",
+		Default: "#",
+		Validate: func(args []string) error {
+			if len(args[0]) > 1 {
+				return errors.New("Character must a string of length 1")
+			}
+			return nil
+		},
+	})
+
+	cellSizeIn := argparser.Int("", "cell-size-in", &argparse.Options{
+		Help:    "Size of a cell (in pixels) for input file of image type",
+		Default: 20,
+	})
+
+	cellSizeOut := argparser.Int("", "cell-size-out", &argparse.Options{
+		Help:    "Size of a cell (in pixels) for output file of image type",
+		Default: 20,
+	})
+
+	solverFactory.Type = argparser.Selector("a", "algo", solver.TYPES, &argparse.Options{
+		Help:    fmt.Sprintf("Algorithm to solve the maze, avaiable options: %s", strings.Join(solver.TYPES, ", ")),
+		Default: solver.TYPES[0],
+	})
+
+	if err := argparser.Parse(os.Args); err != nil {
+		fmt.Println(argparser.Usage(err))
+		return nil, nil, nil, false
+	}
+	utils.VERBOSE_LEVEL = *verboseLevel
+
+	readerFactory.CellHeight, readerFactory.CellWidth = cellSizeIn, cellSizeIn
+	readerFactory.WallColor = color.RGBA{0, 0, 0, 255}
+	readerFactory.PathColor = color.RGBA{255, 255, 255, 255}
+
+	writerFactory.CellHeight, writerFactory.CellWidth = cellSizeOut, cellSizeOut
+	writerFactory.WallColor = color.RGBA{0, 0, 0, 255}
+	writerFactory.PathColor = color.RGBA{255, 255, 255, 255}
+	writerFactory.SolutionGradient = colorgrad.Warm()
+
+	return &readerFactory, &writerFactory, &solverFactory, true
 }

maze/maze.go

@@ -1,8 +1,31 @@
 package maze
 
+import "math"
+
 type Coordinates struct {
 	X, Y int
 }
+
+func (c Coordinates) Distance(o Coordinates) float64 {
+	x, y := float64(o.X-c.X), float64(o.Y-c.Y)
+
+	if y == 0 {
+		if x < 0 {
+			return -x
+		}
+		return x
+	}
+
+	if x == 0 {
+		if y < 0 {
+			return -y
+		}
+		return y
+	}
+
+	return math.Sqrt(x*x + y*y)
+}
+
 type Node struct {
 	Coords      Coordinates
 	Up, Down    *Node
@@ -20,11 +43,11 @@ func NewNode(coords Coordinates) *Node {
 }
 
 type Maze struct {
-	Width, Height uint
+	Width, Height int
 	Nodes         []*Node
 }
 
 type SolvedMaze struct {
-	Maze
+	*Maze
 	Solution []*Node
 }

maze/parser/parser.go

@@ -8,13 +8,18 @@ import (
 
 func Parse(reader reader.Reader) (*maze.Maze, error) {
 	nodesByCoord := make(map[maze.Coordinates]*maze.Node)
-	ret := &maze.Maze{}
 
 	raw_maze, err := reader.Read()
 	if err != nil {
 		return nil, err
 	}
 
+	ret := &maze.Maze{
+		Width:  raw_maze.Width,
+		Height: raw_maze.Height,
+		Nodes:  []*maze.Node{},
+	}
+
 	y := 0
 	// Parse first line to get entrance
 	for x := 0; x < raw_maze.Width-1; x++ {
@@ -30,10 +35,7 @@ func Parse(reader reader.Reader) (*maze.Maze, error) {
 	for y = 1; y < raw_maze.Height-1; y++ {
 		for x := 1; x < raw_maze.Width-1; x++ {
 			// Parse middle of the maze
-			if raw_maze.IsPath(x, y) &&
+			if isCoordEligibleForNode(x, y, raw_maze) {
-				(raw_maze.IsWall(x-1, y) && raw_maze.IsPath(x+1, y) ||
-					raw_maze.IsPath(x-1, y) && raw_maze.IsWall(x+1, y) ||
-					raw_maze.IsPath(x, y-1) && (raw_maze.IsPath(x-1, y) || raw_maze.IsPath(x+1, y))) {
 				coords := maze.Coordinates{X: x, Y: y}
 				node := maze.NewNode(coords)
 
@@ -43,7 +45,8 @@ func Parse(reader reader.Reader) (*maze.Maze, error) {
 				nodesByCoord[coords] = node
 
 				if raw_maze.IsPath(x-1, y) && raw_maze.IsWall(x+1, y) ||
-					raw_maze.IsPath(x, y-1) && (raw_maze.IsPath(x-1, y) || raw_maze.IsPath(x+1, y)) {
+					raw_maze.IsPath(x, y-1) &&
+						(raw_maze.IsPath(x-1, y) || raw_maze.IsPath(x+1, y)) {
 					lookupNeighbourLeft(raw_maze, node, &nodesByCoord)
 				}
 			}
@@ -64,6 +67,14 @@ func Parse(reader reader.Reader) (*maze.Maze, error) {
 	return ret, nil
 }
 
+func isCoordEligibleForNode(x int, y int, raw_maze *reader.RawMaze) bool {
+	return raw_maze.IsPath(x, y) &&
+		(raw_maze.IsWall(x-1, y) && raw_maze.IsPath(x+1, y) || // wall left, path right
+			raw_maze.IsPath(x-1, y) && raw_maze.IsWall(x+1, y) || // path left, wall right
+			raw_maze.IsPath(x, y-1) && (raw_maze.IsPath(x-1, y) || raw_maze.IsPath(x+1, y)) || // path above and not in vertical corridor
+			raw_maze.IsWall(x-1, y) && raw_maze.IsWall(x+1, y) && raw_maze.IsPath(x, y-1) && raw_maze.IsWall(x, y+1)) // wall to left, below, above and path above
+}
+
 func lookupNeighbourAbove(raw_maze *reader.RawMaze, node *maze.Node, nodesByCoord *map[maze.Coordinates]*maze.Node, m *maze.Maze) {
 	for y := node.Coords.Y - 1; y >= 0; y-- {
 		neighbour, ok := (*nodesByCoord)[maze.Coordinates{X: node.Coords.X, Y: y}]
@@ -74,7 +85,7 @@ func lookupNeighbourAbove(raw_maze *reader.RawMaze, node *maze.Node, nodesByCoor
 			break
 		}
 
-		if y > 0 && raw_maze.IsWall(node.Coords.X, y) {
+		if y >= 0 && raw_maze.IsWall(node.Coords.X, y) {
 			y++
 			if y == node.Coords.Y {
 				break
@@ -96,8 +107,12 @@ func lookupNeighbourAbove(raw_maze *reader.RawMaze, node *maze.Node, nodesByCoor
 
 func lookupNeighbourLeft(raw_maze *reader.RawMaze, node *maze.Node, nodesByCoord *map[maze.Coordinates]*maze.Node) {
 	for x := node.Coords.X - 1; x > 0; x-- {
+		if raw_maze.IsWall(x, node.Coords.Y) && x == node.Coords.X-1 {
+			return
+		}
+
 		if raw_maze.IsWall(x, node.Coords.Y) && x < node.Coords.X-1 {
-			panic(fmt.Sprintf("Found no node before wall while looking to the left at neighbours of node %v", node))
+			panic(fmt.Sprintf("Found no node before wall while looking to the left at neighbours of node %v (arrived at x=%v before hitting a wall)", node, x))
 		}
 
 		neighbour, ok := (*nodesByCoord)[maze.Coordinates{X: x, Y: node.Coords.Y}]
@@ -111,7 +126,11 @@ func lookupNeighbourLeft(raw_maze *reader.RawMaze, node *maze.Node, nodesByCoord
 
 func lookupNeighbourRight(raw_maze *reader.RawMaze, node *maze.Node, nodesByCoord *map[maze.Coordinates]*maze.Node) {
 	for x := node.Coords.X + 1; x < raw_maze.Width; x++ {
-		if raw_maze.IsWall(x, node.Coords.Y) {
+		if raw_maze.IsWall(x, node.Coords.Y) && x == node.Coords.X+1 {
+			return
+		}
+
+		if raw_maze.IsWall(x, node.Coords.Y) && x > node.Coords.X+1 {
 			panic(fmt.Sprintf("Found no node before wall while looking to the right at neighbours of node %v", node))
 		}
 

maze/parser/parser_test.go

@@ -9,7 +9,6 @@ import (
 )
 
 func TestTextReadTrivial(t *testing.T) {
-	fmt.Println("---------- Trivial ----------")
 	/* trivial.txt
 	   ## ##
 	   #   #
@@ -43,7 +42,7 @@ func TestTextReadTrivial(t *testing.T) {
 
 	nodes[4].Up = nodes[3]
 
-	reader := reader.TextReader{
+	reader := &reader.TextReader{
 		Filename: "../../assets/trivial.txt",
 		PathChar: ' ',
 		WallChar: '#',
@@ -52,6 +51,9 @@ func TestTextReadTrivial(t *testing.T) {
 	got, err := Parse(reader)
 	utils.Check(err, "Couldn't create maze from %q", reader.Filename)
 
+	utils.AssertEqual(t, got.Width, 5, "Normal: width differ")
+	utils.AssertEqual(t, got.Height, 3, "Normal: height differ")
+
 	if len(nodes) != len(got.Nodes) {
 		t.Fatalf("Didn't get the same size of nodes: %v, want %v", len(got.Nodes), len(nodes))
 	}
@@ -68,7 +70,6 @@ func TestTextReadTrivial(t *testing.T) {
 }
 
 func TestTextReadTrivialBigger(t *testing.T) {
-	fmt.Println("---------- Trivial Bigger ----------")
 	/* trivial-bigger.txt
 	   ### ###
 	   ### ###
@@ -106,7 +107,7 @@ func TestTextReadTrivialBigger(t *testing.T) {
 
 	nodes[4].Up = nodes[3]
 
-	reader := reader.TextReader{
+	reader := &reader.TextReader{
 		Filename: "../../assets/trivial-bigger.txt",
 		PathChar: ' ',
 		WallChar: '#',
@@ -115,14 +116,13 @@ func TestTextReadTrivialBigger(t *testing.T) {
 	got, err := Parse(reader)
 	utils.Check(err, "Couldn't create maze from %q", reader.Filename)
 
+	utils.AssertEqual(t, got.Width, 7, "Normal: width differ")
+	utils.AssertEqual(t, got.Height, 5, "Normal: height differ")
+
 	if len(nodes) != len(got.Nodes) {
 		t.Fatalf("Didn't get the same size of nodes: %v, want %v", len(got.Nodes), len(nodes))
 	}
 
-	for _, node := range got.Nodes {
-		fmt.Println(node)
-	}
-
 	for i, got := range got.Nodes {
 		expected := nodes[i]
 
@@ -135,7 +135,6 @@ func TestTextReadTrivialBigger(t *testing.T) {
 }
 
 func TestTextReadTrivialBiggerStaggered(t *testing.T) {
-	fmt.Println("---------- Trivial Staggered ----------")
 	/* trivial-bigger-staggered.txt
 	   ### ###
 	   ### ###
@@ -178,7 +177,7 @@ func TestTextReadTrivialBiggerStaggered(t *testing.T) {
 
 	nodes[5].Up = nodes[4]
 
-	reader := reader.TextReader{
+	reader := &reader.TextReader{
 		Filename: "../../assets/trivial-bigger-staggered.txt",
 		PathChar: ' ',
 		WallChar: '#',
@@ -187,14 +186,13 @@ func TestTextReadTrivialBiggerStaggered(t *testing.T) {
 	got, err := Parse(reader)
 	utils.Check(err, "Couldn't create maze from %q", reader.Filename)
 
+	utils.AssertEqual(t, got.Width, 7, "Normal: width differ")
+	utils.AssertEqual(t, got.Height, 5, "Normal: height differ")
+
 	if len(nodes) != len(got.Nodes) {
 		t.Fatalf("Didn't get the same size of nodes: %v, want %v", len(got.Nodes), len(nodes))
 	}
 
-	for _, node := range got.Nodes {
-		fmt.Println(node)
-	}
-
 	for i, got := range got.Nodes {
 		expected := nodes[i]
 
@@ -207,9 +205,7 @@ func TestTextReadTrivialBiggerStaggered(t *testing.T) {
 }
 
 func TestTextReadNormal(t *testing.T) {
-	return
+	/* normal.txt
-	fmt.Println("---------- Normal ----------")
-	/* trivial-bigger-staggered.txt
 		##### #####
 		#     #   #
 		##### ### #
@@ -228,14 +224,13 @@ func TestTextReadNormal(t *testing.T) {
 		##### ### #
 		#5 6#7   8#
 		# # ##### #
-		#9#A   G B#
+		#9#A   F B#
 		### ### # #
-		#C D#E F# #
+		#C D#E G# #
 		# ####### #
 		#H   I#J K#
 		#####L#####
 	*/
-	// TODO: we are not detecting vertical dead-ends that go downwards
 	nodes := make([]*maze.Node, 22)
 
 	// ---- Node creation ----
@@ -254,13 +249,13 @@ func TestTextReadNormal(t *testing.T) {
 
 		{1, 5}, // 9
 		{3, 5}, // A (10)
-		{7, 5}, // G (16)
 		{9, 5}, // B (11)
 
 		{1, 7}, // C (12)
 		{3, 7}, // D (13)
 		{5, 7}, // E (14)
-		{7, 7}, // F (15)
+		{7, 5}, // F (15)
+		{7, 7}, // G (16)
 
 		{1, 9}, // H (17)
 		{5, 9}, // I (18)
@@ -275,70 +270,47 @@ func TestTextReadNormal(t *testing.T) {
 	}
 
 	// ---- Node linking ----
-	nodes[0].Down = nodes[2]
+	// Vertical
+	links := []struct {
+		from, to int
+	}{
+		{0, 2},
+		{2, 7},
+		{4, 8},
+		{5, 9},
+		{6, 10},
+		{8, 11},
+		{10, 13},
+		{15, 16},
+		{11, 20},
+		{12, 17},
+		{18, 21},
+	}
+	for _, link := range links {
+		nodes[link.from].Down = nodes[link.to]
+		nodes[link.to].Up = nodes[link.from]
+	}
 
-	nodes[1].Right = nodes[2]
+	links = []struct {
+		from, to int
+	}{
+		{1, 2},
+		{3, 4},
+		{5, 6},
+		{7, 8},
+		{10, 15},
+		{15, 11},
+		{12, 13},
+		{14, 16},
+		{17, 18},
+		{19, 20},
+	}
+	for _, link := range links {
+		nodes[link.from].Right = nodes[link.to]
+		nodes[link.to].Left = nodes[link.from]
+	}
 
-	nodes[2].Up = nodes[0]
+	reader := &reader.TextReader{
-	nodes[2].Left = nodes[1]
-	nodes[2].Down = nodes[7]
-
-	nodes[3].Right = nodes[4]
-
-	nodes[4].Left = nodes[3]
-	nodes[4].Down = nodes[8]
-
-	nodes[5].Right = nodes[6]
-	nodes[5].Down = nodes[9]
-
-	nodes[6].Left = nodes[5]
-	nodes[6].Down = nodes[10]
-
-	nodes[7].Right = nodes[8]
-
-	nodes[8].Up = nodes[4]
-	nodes[8].Left = nodes[7]
-	nodes[8].Down = nodes[11]
-
-	nodes[9].Up = nodes[5]
-
-	nodes[10].Up = nodes[6]
-	nodes[10].Right = nodes[16]
-	nodes[10].Down = nodes[13]
-
-	nodes[11].Up = nodes[6]
-	nodes[11].Right = nodes[16]
-	nodes[11].Down = nodes[20]
-
-	nodes[12].Right = nodes[13]
-	nodes[12].Down = nodes[17]
-
-	nodes[13].Up = nodes[10]
-	nodes[13].Left = nodes[16]
-
-	nodes[14].Right = nodes[15]
-
-	nodes[15].Up = nodes[16]
-	nodes[15].Left = nodes[14]
-
-	nodes[16].Left = nodes[10]
-	nodes[16].Right = nodes[11]
-	nodes[16].Down = nodes[15]
-
-	nodes[17].Up = nodes[12]
-	nodes[17].Right = nodes[18]
-
-	nodes[18].Left = nodes[17]
-	nodes[18].Down = nodes[21]
-
-	nodes[19].Right = nodes[20]
-
-	nodes[20].Up = nodes[11]
-	nodes[20].Left = nodes[19]
-
-	nodes[21].Up = nodes[20]
-
-	reader := reader.TextReader{
 		Filename: "../../assets/normal.txt",
 		PathChar: ' ',
 		WallChar: '#',
@@ -347,6 +319,9 @@ func TestTextReadNormal(t *testing.T) {
 	got, err := Parse(reader)
 	utils.Check(err, "Couldn't create maze from %q", reader.Filename)
 
+	utils.AssertEqual(t, got.Width, 11, "Normal: width differ")
+	utils.AssertEqual(t, got.Height, 11, "Normal: height differ")
+
 	if len(nodes) != len(got.Nodes) {
 		for i, node := range got.Nodes {
 			fmt.Printf("%v: %v\n", i, node)
@@ -354,8 +329,195 @@ func TestTextReadNormal(t *testing.T) {
 		t.Fatalf("Didn't get the same size of nodes: %v, want %v", len(got.Nodes), len(nodes))
 	}
 
-	for _, node := range got.Nodes {
+	for i, got := range got.Nodes {
-		fmt.Println(node)
+		expected := nodes[i]
+
+		checkNode(t, i, got, expected, "")
+		checkNode(t, i, got.Left, expected.Left, "left")
+		checkNode(t, i, got.Right, expected.Right, "Right")
+		checkNode(t, i, got.Up, expected.Up, "Up")
+		checkNode(t, i, got.Down, expected.Down, "Down")
+	}
+}
+
+func TestTextReadNormal2(t *testing.T) {
+	/* normal2.txt
+	   ####### #######
+	   #   #       # #
+	   ### # ##### # #
+	   #   #     #   #
+	   # ########### #
+	   #     #     # #
+	   ### # # ##### #
+	   #   #   #   # #
+	   # ### ### # # #
+	   # #   #   #   #
+	   # ### # #######
+	   #   # # #     #
+	   # # ### ### # #
+	   # #         # #
+	   ####### #######
+
+	   Nodes are
+	   #######0#######
+	   #1 2#3 4   5#B#
+	   ### # ##### # #
+	   #6 7#8   9#A C#
+	   # ########### #
+	   #D I E#F   G# #
+	   ### # # ##### #
+	   #H J#K L#M N# #
+	   # ### ### # # #
+	   # #O P#Q R#S T#
+	   # ### # #######
+	   #U V#W# #X C Y#
+	   # # ### ### # #
+	   #Z#A   B   D#E#
+	   #######F#######
+	*/
+	nodes := make([]*maze.Node, 42)
+
+	// ---- Node creation ----
+	coords := []struct{ x, y int }{
+		{7, 0}, // 0
+
+		{1, 1},  // 1
+		{3, 1},  // 2
+		{5, 1},  // 3
+		{7, 1},  // 4
+		{11, 1}, // 5
+
+		{1, 3},  // 6
+		{3, 3},  // 7
+		{5, 3},  // 8
+		{9, 3},  // 9
+		{11, 3}, // 10 (A)
+		{13, 1}, // 11 (B)
+		{13, 3}, // 12 (C)
+
+		{1, 5},  // 13 (D)
+		{5, 5},  // 14 (E)
+		{7, 5},  // 15 (F)
+		{11, 5}, // 16 (G)
+
+		{1, 7},  // 17 (H)
+		{3, 5},  // 18 (I)
+		{3, 7},  // 19 (J)
+		{5, 7},  // 20 (K)
+		{7, 7},  // 21 (L)
+		{9, 7},  // 22 (M)
+		{11, 7}, // 23 (N)
+
+		{3, 9},  // 24 (O)
+		{5, 9},  // 25 (P)
+		{7, 9},  // 26 (Q)
+		{9, 9},  // 27 (R)
+		{11, 9}, // 28 (S)
+		{13, 9}, // 29 (T)
+
+		{1, 11},  // 30 (U)
+		{3, 11},  // 31 (V)
+		{5, 11},  // 32 (W)
+		{9, 11},  // 33 (X)
+		{13, 11}, // 34 (Y)
+
+		{1, 13},  // 35 (Z)
+		{3, 13},  // 36 (AA)
+		{7, 13},  // 37 (AB)
+		{11, 11}, // 38 (AC)
+		{11, 13}, // 39 (AD)
+		{13, 13}, // 40 (AE)
+
+		{7, 14}, // 42 (AF)
+	}
+
+	for i, coord := range coords {
+		nodes[i] = maze.NewNode(maze.Coordinates{X: coord.x, Y: coord.y})
+	}
+
+	// ---- Node linking ----
+	// Vertical
+	links := []struct {
+		from, to int
+	}{
+		{0, 4},
+		{2, 7},
+		{3, 8},
+		{5, 10},
+		{11, 12},
+		{6, 13},
+		{12, 29},
+		{18, 19},
+		{14, 20},
+		{15, 21},
+		{17, 30},
+		{20, 25},
+		{22, 27},
+		{23, 28},
+		{25, 32},
+		{26, 37},
+		{30, 35},
+		{31, 36},
+		{38, 39},
+		{34, 40},
+		{37, 41},
+	}
+	for _, link := range links {
+		nodes[link.from].Down = nodes[link.to]
+		nodes[link.to].Up = nodes[link.from]
+	}
+
+	links = []struct {
+		from, to int
+	}{
+		{1, 2},
+		{3, 4},
+		{4, 5},
+
+		{6, 7},
+		{8, 9},
+		{10, 12},
+
+		{13, 18},
+		{18, 14},
+		{15, 16},
+
+		{17, 19},
+		{20, 21},
+		{22, 23},
+
+		{24, 25},
+		{26, 27},
+		{28, 29},
+
+		{30, 31},
+		{33, 38},
+		{38, 34},
+		{36, 37},
+		{37, 39},
+	}
+	for _, link := range links {
+		nodes[link.from].Right = nodes[link.to]
+		nodes[link.to].Left = nodes[link.from]
+	}
+
+	reader := &reader.TextReader{
+		Filename: "../../assets/normal2.txt",
+		PathChar: ' ',
+		WallChar: '#',
+	}
+
+	got, err := Parse(reader)
+	utils.Check(err, "Couldn't create maze from %q", reader.Filename)
+
+	utils.AssertEqual(t, got.Width, 15, "Normal 2: width differ")
+	utils.AssertEqual(t, got.Height, 15, "Normal 2: height differ")
+
+	if len(nodes) != len(got.Nodes) {
+		for i, node := range got.Nodes {
+			fmt.Printf("%v: %v\n", i, node)
+		}
+		t.Fatalf("Didn't get the same size of nodes: %v, want %v", len(got.Nodes), len(nodes))
 	}
 
 	for i, got := range got.Nodes {
@@ -370,11 +532,15 @@ func TestTextReadNormal(t *testing.T) {
 }
 
 func checkNode(t *testing.T, i int, got *maze.Node, expected *maze.Node, side string) {
-	if expected == nil {
+	if expected == nil && got != nil {
+		t.Fatalf("Somehow there is a node %s of %v, didn't want any", side, i)
+	}
+
+	if expected == nil && got == nil {
 		return
 	}
 
-	if got == nil {
+	if expected != nil && got == nil {
 		t.Fatalf("No %s node of %v, want %v", side, i, expected.Coords)
 	}
 

solver/solver.go

@@ -1,7 +1,30 @@
 package solver
 
-import "maze-solver/maze"
+import (
+	"fmt"
+	"maze-solver/maze"
+)
 
 type Solver interface {
 	Solve(*maze.Maze) *maze.SolvedMaze
 }
+
+type SolverFactory struct {
+	Type *string
+}
+
+const (
+	_TURN_LEFT = "turn-left"
+)
+
+var TYPES = []string{
+	_TURN_LEFT,
+}
+
+func (f *SolverFactory) Get() Solver {
+	switch *f.Type {
+	case _TURN_LEFT:
+		return &TurnLeftSolver{}
+	}
+	panic(fmt.Sprintf("Unrecognized solver type %q", *f.Type))
+}

solver/turn_left.go

@@ -0,0 +1,63 @@
+package solver
+
+import (
+	"maze-solver/maze"
+	"maze-solver/utils"
+)
+
+type TurnLeftSolver struct {
+	visited map[*maze.Node]bool
+}
+
+func (s *TurnLeftSolver) Solve(m *maze.Maze) *maze.SolvedMaze {
+	defer utils.Timer("Turn left algorithm", 2)()
+
+	current, end := m.Nodes[0], m.Nodes[len(m.Nodes)-1]
+	s.visited = make(map[*maze.Node]bool, len(m.Nodes))
+
+	for _, node := range m.Nodes {
+		s.visited[node] = false
+	}
+
+	stack := make([]*maze.Node, 0, len(m.Nodes))
+	stack = append(stack, current)
+
+	for current != end {
+		s.visited[current] = true
+
+		left_visited, right_visited, up_visited, down_visited := s.wasVisited(current.Left), s.wasVisited(current.Right), s.wasVisited(current.Up), s.wasVisited(current.Down)
+
+		if left_visited && right_visited && up_visited && down_visited {
+			// dead end or no more visited nodes
+			stack = stack[:len(stack)-1]
+			current = stack[len(stack)-1]
+		} else {
+
+			if !left_visited {
+				current = current.Left
+			} else if !down_visited {
+				current = current.Down
+			} else if !right_visited {
+				current = current.Right
+			} else if !up_visited {
+				current = current.Up
+			}
+
+			stack = append(stack, current)
+		}
+	}
+
+	ret := &maze.SolvedMaze{
+		Maze:     m,
+		Solution: stack,
+	}
+	return ret
+}
+
+func (s *TurnLeftSolver) wasVisited(node *maze.Node) bool {
+	if node == nil {
+		return true
+	}
+	visited, _ := s.visited[node]
+	return visited
+}

utils/utils.go

@@ -1,7 +1,10 @@
 package utils
 
 import (
+	"fmt"
 	"log"
+	"testing"
+	"time"
 
 	"golang.org/x/exp/constraints"
 )
@@ -19,3 +22,21 @@ func Min[T constraints.Ordered](a, b T) T {
 	}
 	return b
 }
+
+func AssertEqual[T comparable](t *testing.T, got T, want T, msg string, args ...any) {
+	args = append(args, got, want)
+	if got != want {
+		t.Fatalf(msg+"\nGot: %v, Want: %v", args...)
+	}
+}
+
+var VERBOSE_LEVEL int
+
+func Timer(msg string, level int) func() {
+	start := time.Now()
+	return func() {
+		if level <= VERBOSE_LEVEL {
+			fmt.Printf("%-19s %12v\n", msg, time.Since(start))
+		}
+	}
+}