Removed useless print statements

was actually dfs lol

.github/workflows/automatic-prerelease.yml

@@ -0,0 +1,33 @@
+---
+name: "pre-release"
+
+on:
+  push:
+    branches:
+      - "main"
+
+jobs:
+  pre-release:
+    name: "Pre Release"
+    runs-on: "ubuntu-latest"
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: "1.21"
+
+      - name: Build
+        run: go build -v ./...
+
+      - name: Test
+        run: go test -v ./...
+
+      - uses: "marvinpinto/action-automatic-releases@latest"
+        with:
+          repo_token: "${{ secrets.GITHUB_TOKEN }}"
+          automatic_release_tag: "latest"
+          prerelease: true
+          title: "Development Build"

.github/workflows/tagged-release.yml

@@ -0,0 +1,31 @@
+---
+name: "tagged-release"
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  tagged-release:
+    name: "Tagged Release"
+    runs-on: "ubuntu-latest"
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: "1.21"
+
+      - name: Build
+        run: go build -v ./...
+
+      - name: Test
+        run: go test -v ./...
+
+      - uses: "marvinpinto/action-automatic-releases@latest"
+        with:
+          repo_token: "${{ secrets.GITHUB_TOKEN }}"
+          prerelease: false

.gitignore

@@ -20,3 +20,5 @@
 # Go workspace file
 go.work
 /Session.vim
+/maze.png
+/maze_sol.png

io/writer/image_test.go

@@ -1,17 +1,24 @@
 package writer
 
 import (
+	"bytes"
 	"image/color"
+	"io"
 	"maze-solver/maze"
+	"os"
 	"testing"
 
 	"github.com/mazznoer/colorgrad"
 )
 
+const (
+	OUT_DIR      = "./out"
+	EXPECTED_DIR = "../../assets/solved"
+)
+
 func TestImageWriter(t *testing.T) {
-	pathGradient, err := colorgrad.NewGradient().Colors(color.White).Build()
-	if err != nil {
-		panic(err)
+	if _, err := os.Stat(OUT_DIR); os.IsNotExist(err) {
+		os.Mkdir(OUT_DIR, 0700)
 	}
 
 	tests := []struct {
@@ -24,33 +31,33 @@ func TestImageWriter(t *testing.T) {
 	}{
 		{
 			"Trivial",
-			"../../out/trivial_sol.png",
+			"trivial.png",
 			trivial(),
-			40, 40,
+			20, 20,
 			color.White, color.Black,
 			colorgrad.Warm(),
 		},
 		{
-			"Bigger",
-			"../../out/bigger_sol.png",
+			"Trivial Bigger",
+			"trivial-bigger.png",
 			bigger(),
-			40, 40,
+			20, 20,
 			color.White, color.Black,
 			colorgrad.Warm(),
 		},
 		{
-			"Bigger Staggered",
-			"../../out/bigger_staggered_sol.png",
+			"Trivial Bigger Staggered",
+			"trivial-bigger-staggered.png",
 			bigger_staggered(),
-			40, 40,
+			20, 20,
 			color.White, color.Black,
-			pathGradient,
+			colorgrad.Warm(),
 		},
 		{
 			"Normal",
-			"../../out/normal_sol.png",
+			"normal.png",
 			normal(),
-			40, 40,
+			20, 20,
 			color.White, color.Black,
 			colorgrad.Warm(),
 		},
@@ -58,7 +65,7 @@ func TestImageWriter(t *testing.T) {
 
 	for _, test := range tests {
 		writer := ImageWriter{
-			Filename:         test.filename,
+			Filename:         OUT_DIR + "/" + test.filename,
 			Maze:             test.m,
 			CellWidth:        test.CellWidth,
 			CellHeight:       test.cellHeight,
@@ -71,5 +78,45 @@ func TestImageWriter(t *testing.T) {
 		if err != nil {
 			t.Fatalf("%s: couldn't write solution, got following error\n%v", test.name, err)
 		}
+
+		assertEqualFile(t, EXPECTED_DIR+"/"+test.filename, OUT_DIR+"/"+test.filename, test.name)
+		os.Remove(writer.Filename)
+	}
+	os.Remove(OUT_DIR)
+}
+
+const chunkSize = 64000
+
+func assertEqualFile(t *testing.T, file1, file2, name string) {
+	f1, err := os.Open(file1)
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer f1.Close()
+
+	f2, err := os.Open(file2)
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer f2.Close()
+
+	for {
+		b1 := make([]byte, chunkSize)
+		_, err1 := f1.Read(b1)
+
+		b2 := make([]byte, chunkSize)
+		_, err2 := f2.Read(b2)
+
+		if err1 != nil || err2 != nil {
+			if err1 == io.EOF && err2 == io.EOF {
+				return
+			} else if err1 == io.EOF || err2 == io.EOF {
+				t.Fatalf("%s: files are not equal. Got %q, wanted %q", name, file1, file2)
+			}
+		}
+
+		if !bytes.Equal(b1, b2) {
+			t.Fatalf("%s: files are not equal. Got %q, wanted %q", name, file1, file2)
+		}
 	}
 }

io/writer/strings_test.go

@@ -1,7 +1,6 @@
 package writer
 
 import (
-	"fmt"
 	"maze-solver/maze"
 	"maze-solver/utils"
 	"testing"
@@ -69,7 +68,6 @@ func TestStringsWriter(t *testing.T) {
 	}
 
 	for _, test := range tests {
-		fmt.Printf("----------- %s -----------\n", test.name)
 		writer := StringsWriter{
 			PathChar:     test.pathChar,
 			WallChar:     test.wallChar,

main.go

@@ -17,6 +17,28 @@ import (
 )
 
 func main() {
+	readerFactory, writerFactory, solverFactory, ok := parse_arguments()
+
+	if !ok {
+		return
+	}
+
+	defer utils.Timer("TOTAL", 1)()
+	reader := readerFactory.Get()
+
+	maze, err := parser.Parse(reader)
+	utils.Check(err, "Couldn't read maze")
+
+	solver := solverFactory.Get()
+	solved := solver.Solve(maze)
+
+	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{
@@ -124,7 +146,7 @@ func main() {
 
 	if err := argparser.Parse(os.Args); err != nil {
 		fmt.Println(argparser.Usage(err))
-		return
+		return nil, nil, nil, false
 	}
 	utils.VERBOSE_LEVEL = *verboseLevel
 
@@ -137,18 +159,5 @@ func main() {
 	writerFactory.PathColor = color.RGBA{255, 255, 255, 255}
 	writerFactory.SolutionGradient = colorgrad.Warm()
 
-	defer utils.Timer("TOTAL", 1)()
-
-	reader := readerFactory.Get()
-
-	maze, err := parser.Parse(reader)
-	utils.Check(err, "Couldn't read maze")
-
-	solver := solverFactory.Get()
-	solved := solver.Solve(maze)
-
-	writer := writerFactory.Get(solved)
-
-	err = writer.Write()
-	utils.Check(err, "Couldn't write solved maze")
+	return &readerFactory, &writerFactory, &solverFactory, true
 }

maze/parser/parser_test.go

@@ -42,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: '#',
@@ -107,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: '#',
@@ -177,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: '#',
@@ -310,7 +310,7 @@ func TestTextReadNormal(t *testing.T) {
 		nodes[link.to].Left = nodes[link.from]
 	}
 
-	reader := reader.TextReader{
+	reader := &reader.TextReader{
 		Filename: "../../assets/normal.txt",
 		PathChar: ' ',
 		WallChar: '#',
@@ -501,7 +501,7 @@ func TestTextReadNormal2(t *testing.T) {
 		nodes[link.to].Left = nodes[link.from]
 	}
 
-	reader := reader.TextReader{
+	reader := &reader.TextReader{
 		Filename: "../../assets/normal2.txt",
 		PathChar: ' ',
 		WallChar: '#',

solver/dfs.go

@@ -5,11 +5,11 @@ import (
 	"maze-solver/utils"
 )
 
-type TurnLeftSolver struct {
+type DFSSolver struct {
 	visited map[*maze.Node]bool
 }
 
-func (s *TurnLeftSolver) Solve(m *maze.Maze) *maze.SolvedMaze {
+func (s *DFSSolver) Solve(m *maze.Maze) *maze.SolvedMaze {
 	defer utils.Timer("Turn left algorithm", 2)()
 
 	current, end := m.Nodes[0], m.Nodes[len(m.Nodes)-1]
@@ -54,7 +54,7 @@ func (s *TurnLeftSolver) Solve(m *maze.Maze) *maze.SolvedMaze {
 	return ret
 }
 
-func (s *TurnLeftSolver) wasVisited(node *maze.Node) bool {
+func (s *DFSSolver) wasVisited(node *maze.Node) bool {
 	if node == nil {
 		return true
 	}

solver/solver.go

@@ -24,7 +24,7 @@ var TYPES = []string{
 func (f *SolverFactory) Get() Solver {
 	switch *f.Type {
 	case _TURN_LEFT:
-		return &TurnLeftSolver{}
+		return &DFSSolver{}
 	}
 	panic(fmt.Sprintf("Unrecognized solver type %q", *f.Type))
 }