Merge pull request #84 from codecrafters-io/CC-1716

Refactor file and directory operations, remove unused code

Author: ryan-gang

.github/workflows/test.yml

@@ -7,13 +7,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Set up Go
-        uses: actions/setup-go@v1
+        uses: actions/setup-go@v5
         with:
-          go-version: 1.21.x
+          go-version: 1.24.x
       - name: Set up Python
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v5
         with:
-          python-version: '3.8'
+          python-version: '3.12'
       - run: make test

Makefile

@@ -14,9 +14,9 @@ test:
 	go test -v ./internal/
 
 test_with_git: build
-	CODECRAFTERS_SUBMISSION_DIR=$(shell pwd)/internal/test_helpers/pass_all \
+	CODECRAFTERS_REPOSITORY_DIR=$(shell pwd)/internal/test_helpers/pass_all \
 	CODECRAFTERS_TEST_CASES_JSON='[{"slug":"gg4","tester_log_prefix":"stage-1","title":"Stage #1: Initialize the .git directory"},{"slug":"ic4","tester_log_prefix":"stage-2","title":"Stage #2: Read a blob object"},{"slug":"jt4","tester_log_prefix":"stage-3","title":"Stage #3: Create a blob object"},{"slug":"kp1","tester_log_prefix":"stage-4","title":"Stage #4: Read a tree object"},{"slug":"fe4","tester_log_prefix":"stage-5","title":"Stage #5: Write a tree object"},{"slug":"jm9","tester_log_prefix":"stage-6","title":"Stage #6: Create a commit"},{"slug":"mg6","tester_log_prefix":"stage-7","title":"Stage #7: Clone a repository"}]' \
-	dist/main.out
+	$(shell pwd)/dist/main.out
 
 copy_course_file:
 	hub api \

go.mod

@@ -1,8 +1,6 @@
 module github.com/codecrafters-io/git-tester
 
-go 1.21
-
-toolchain go1.22.1
+go 1.23
 
 require (
 	github.com/codecrafters-io/tester-utils v0.2.38

internal/stage_clone_repository.go

@@ -2,11 +2,10 @@ package internal
 
 import (
 	"fmt"
-	"io/ioutil"
-	"math/rand"
+	"os"
 	"path"
-	"time"
 
+	"github.com/codecrafters-io/tester-utils/random"
 	"github.com/codecrafters-io/tester-utils/test_case_harness"
 
 	"github.com/go-git/go-git/v5"
@@ -25,46 +24,46 @@ type TestRepo struct {
 }
 
 func (r TestRepo) randomCommit() string {
-	return r.exampleCommits[rand.Intn(len(r.exampleCommits))]
+	return r.exampleCommits[random.RandomInt(0, len(r.exampleCommits))]
 }
 
 func (r TestRepo) randomFile() TestFile {
-	return r.exampleFiles[rand.Intn(len(r.exampleFiles))]
+	return r.exampleFiles[random.RandomInt(0, len(r.exampleFiles))]
 }
 
 var testRepos []TestRepo = []TestRepo{
-	TestRepo{
+	{
 		url: "https://github.com/codecrafters-io/git-sample-1",
 		exampleCommits: []string{
 			"3b0466d22854e57bf9ad3ccf82008a2d3f199550",
 		},
 		exampleFiles: []TestFile{
-			TestFile{
+			{
 				path:     "scooby/dooby/doo",
 				contents: "dooby yikes dumpty scooby monkey donkey horsey humpty vanilla doo",
 			},
 		},
 	},
-	TestRepo{
+	{
 		url: "https://github.com/codecrafters-io/git-sample-2",
 		exampleCommits: []string{
 			"b521b9179412d90a893bc36f33f5dcfd987105ef",
 		},
 		exampleFiles: []TestFile{
-			TestFile{
+			{
 				path:     "humpty/vanilla/yikes",
 				contents: "scooby yikes dooby",
 			},
 		},
 	},
-	TestRepo{
+	{
 		url: "https://github.com/codecrafters-io/git-sample-3",
 		exampleCommits: []string{
 			"23f0bc3b5c7c3108e41c448f01a3db31e7064bbb",
 			"b521b9179412d90a893bc36f33f5dcfd987105ef",
 		},
 		exampleFiles: []TestFile{
-			TestFile{
+			{
 				path:     "donkey/donkey/monkey",
 				contents: "monkey humpty doo scooby dumpty donkey vanilla horsey dooby",
 			},
@@ -73,17 +72,15 @@ var testRepos []TestRepo = []TestRepo{
 }
 
 func randomRepo() TestRepo {
-	rand.Seed(time.Now().UnixNano())
-	return testRepos[rand.Intn(3)]
+	index := random.RandomInt(0, len(testRepos))
+	return testRepos[index]
 }
 
 func testCloneRepository(harness *test_case_harness.TestCaseHarness) error {
-	initRandom()
-
 	logger := harness.Logger
 	executable := harness.Executable
 
-	tempDir, err := ioutil.TempDir("", "worktree")
+	tempDir, err := os.MkdirTemp("", "worktree")
 	if err != nil {
 		return err
 	}
@@ -128,7 +125,7 @@ func testCloneRepository(harness *test_case_harness.TestCaseHarness) error {
 	testFile := testRepo.randomFile()
 
 	logger.Debugf("Reading contents of a sample file")
-	bytes, err := ioutil.ReadFile(path.Join(repoDir, testFile.path))
+	bytes, err := os.ReadFile(path.Join(repoDir, testFile.path))
 	if err != nil {
 		return err
 	}

internal/stage_create_blob.go

@@ -12,8 +12,6 @@ import (
 )
 
 func testCreateBlob(harness *test_case_harness.TestCaseHarness) error {
-	initRandom()
-
 	logger := harness.Logger
 	executable := harness.Executable
 

internal/stage_create_commit.go

@@ -2,24 +2,23 @@ package internal
 
 import (
 	"fmt"
-	"io/ioutil"
+	"os"
 	"path"
 	"strings"
 	"time"
 
+	"github.com/codecrafters-io/tester-utils/random"
 	"github.com/codecrafters-io/tester-utils/test_case_harness"
 	"github.com/go-git/go-git/v5"
 	"github.com/go-git/go-git/v5/plumbing"
 	"github.com/go-git/go-git/v5/plumbing/object"
 )
 
 func testCreateCommit(harness *test_case_harness.TestCaseHarness) error {
-	initRandom()
-
 	logger := harness.Logger
 	executable := harness.Executable
 
-	tempDir, err := ioutil.TempDir("", "worktree")
+	tempDir, err := os.MkdirTemp("", "worktree")
 	if err != nil {
 		return err
 	}
@@ -34,11 +33,11 @@ func testCreateCommit(harness *test_case_harness.TestCaseHarness) error {
 	logger.Debugf("Creating some files & directories")
 
 	rootFile := "root.txt"
-	firstLevel := randomStringsShort(3)
+	firstLevel := random.RandomWords(3)
 	rootFile, rootDir1, rootDir2 := firstLevel[0], firstLevel[1], firstLevel[2]
-	secondLevel := randomStringsShort(2)
+	secondLevel := random.RandomWords(2)
 	rootDir1File1, rootDir1File2 := secondLevel[0], secondLevel[1]
-	thirdLevel := randomStringsShort(2)
+	thirdLevel := random.RandomWords(2)
 	rootDir2File1, rootDir2File2 := thirdLevel[0], thirdLevel[1]
 
 	writeFile(tempDir, rootFile)
@@ -98,7 +97,7 @@ func testCreateCommit(harness *test_case_harness.TestCaseHarness) error {
 
 	treeSha := nextCommit.TreeHash.String()
 
-	commitMessage := randomString()
+	commitMessage := random.RandomString()
 	logger.Infof("$ ./%s commit-tree <tree_sha> -p <commit_sha> -m <message>", path.Base(executable.Path))
 	result, err := executable.Run("commit-tree", treeSha, "-p", parentCommitSha, "-m", commitMessage)
 	if err != nil {

internal/stage_helpers.go

@@ -2,21 +2,18 @@ package internal
 
 import (
 	"fmt"
-	"io/ioutil"
 	"os"
 	"path"
 
-	logger "github.com/codecrafters-io/tester-utils/logger"
+	"github.com/codecrafters-io/tester-utils/logger"
 	"github.com/codecrafters-io/tester-utils/test_case_harness"
 )
 
 func testInit(harness *test_case_harness.TestCaseHarness) error {
-	initRandom()
-
 	logger := harness.Logger
 	executable := harness.Executable
 
-	tempDir, err := ioutil.TempDir("", "worktree")
+	tempDir, err := os.MkdirTemp("", "worktree")
 	if err != nil {
 		return err
 	}
@@ -55,7 +52,7 @@ func testInit(harness *test_case_harness.TestCaseHarness) error {
 }
 
 func assertHeadFileContents(friendlyName string, path string) error {
-	bytes, err := ioutil.ReadFile(path)
+	bytes, err := os.ReadFile(path)
 	if err != nil {
 		return err
 	}
@@ -102,7 +99,7 @@ func logDebugTree(logger *logger.Logger, dir string) {
 }
 
 func doLogDebugTree(logger *logger.Logger, dir string, prefix string) {
-	entries, err := ioutil.ReadDir(dir)
+	entries, err := os.ReadDir(dir)
 	if err != nil {
 		panic(err)
 	}