Skip to content

Revert "feat: allow usage of --prune with --preserve-dir" #525

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gabrie30 merged 2 commits into from
May 11, 2025
Merged

Revert "feat: allow usage of --prune with --preserve-dir" #525

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9a352ac
Revert "feat: allow usage of --prune with --preserve-dir (#521)"
gabrie30 May 11, 2025
70ed957
Update CHANGELOG.md
gabrie30 May 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)

## [1.11.2] - unreleased
### Added
- Prune to work with gitlabs preserve dir; thanks @Fraguinha
### Changed
### Deprecated
### Removed
Expand Down
43 changes: 9 additions & 34 deletions cmd/clone.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import (
"bufio"
"crypto/sha256"
"fmt"
"io/fs"
"log"
"net/url"
"os"
Expand Down Expand Up @@ -557,13 +556,7 @@ func printDryRun(repos []scm.Repo) {
// to do.
colorlog.PrintInfo("\nScanning for local clones that have been removed on remote...")

var files []os.DirEntry
var err error
if os.Getenv("GHORG_PRESERVE_DIRECTORY_STRUCTURE") == "true" {
files, err = readDirRecursively(outputDirAbsolutePath)
} else {
files, err = os.ReadDir(outputDirAbsolutePath)
}
files, err := os.ReadDir(outputDirAbsolutePath)
if err != nil {
log.Fatal(err)
}
Expand Down Expand Up @@ -606,25 +599,6 @@ func getCloneableInventory(allRepos []scm.Repo) (int, int, int, int) {
return total, repos, snippets, wikis
}

func isGitRepository(path string) bool {
file, err := os.Stat(filepath.Join(path, ".git"))
return err == nil && file.IsDir()
}

func readDirRecursively(name string) ([]os.DirEntry, error) {
var files []os.DirEntry
err := filepath.WalkDir(name, func(path string, file fs.DirEntry, err error) error {
if err != nil {
return err
}
if path != outputDirAbsolutePath && file.IsDir() && isGitRepository(path) {
files = append(files, file)
}
return nil
})
return files, err
}

// CloneAllRepos clones all repos
func CloneAllRepos(git git.Gitter, cloneTargets []scm.Repo) {
// Filter repos that have attributes that don't need specific scm api calls
Expand Down Expand Up @@ -1320,13 +1294,7 @@ func pruneRepos(cloneTargets []scm.Repo) int {
count := 0
colorlog.PrintInfo("\nScanning for local clones that have been removed on remote...")

var files []os.DirEntry
var err error
if os.Getenv("GHORG_PRESERVE_DIRECTORY_STRUCTURE") == "true" {
files, err = readDirRecursively(outputDirAbsolutePath)
} else {
files, err = os.ReadDir(outputDirAbsolutePath)
}
files, err := os.ReadDir(outputDirAbsolutePath)
if err != nil {
log.Fatal(err)
}
Expand Down Expand Up @@ -1397,7 +1365,14 @@ func interactiveYesNoPrompt(prompt string) bool {
}

// There's probably a nicer way of finding whether any scm.Repo in the slice matches a given name.
// TODO, currently this does not work if user sets --preserve-dir see https://github.com/gabrie30/ghorg/issues/210 for more info
func sliceContainsNamedRepo(haystack []scm.Repo, needle string) bool {

if os.Getenv("GHORG_PRESERVE_DIRECTORY_STRUCTURE") == "true" {
colorlog.PrintError("GHORG_PRUNE (--prune) does not currently work in combination with GHORG_PRESERVE_DIRECTORY_STRUCTURE (--preserve-dir), this will come in later versions")
os.Exit(1)
}

for _, repo := range haystack {
basepath := filepath.Base(repo.Path)

Expand Down
101 changes: 0 additions & 101 deletions cmd/clone_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import (
"errors"
"log"
"os"
"path/filepath"
"reflect"
"strings"
"testing"
Expand Down Expand Up @@ -526,103 +525,3 @@ func Test_filterDownReposIfTargetReposPathEnabled(t *testing.T) {
})
}
}

func TestReadDirRecursively(t *testing.T) {
dir, err := os.MkdirTemp("", "testing")
if err != nil {
t.Fatalf("Failed to create temp directory: %v", err)
}
defer os.RemoveAll(dir)

outputDirAbsolutePath = dir

subDir := filepath.Join(dir, "subdir")
if err := os.Mkdir(subDir, 0o755); err != nil {
t.Fatalf("Failed to create subdirectory: %v", err)
}

gitDir := filepath.Join(subDir, ".git")
if err := os.Mkdir(gitDir, 0o755); err != nil {
t.Fatalf("Failed to create subdirectory: %v", err)
}

files, err := readDirRecursively(dir)
if err != nil {
t.Fatalf("readDirRecursively returned an error: %v", err)
}

if len(files) != 1 {
t.Errorf("Expected %d directories, got %d", 1, len(files))
}

if len(files) > 0 && files[0].Name() != "subdir" {
t.Errorf("Expected directory name 'subdir', got '%s'", files[0].Name())
}
}

func TestReadDirRecursivelyNoGitDir(t *testing.T) {
dir, err := os.MkdirTemp("", "testing")
if err != nil {
t.Fatalf("Failed to create temp directory: %v", err)
}
defer os.RemoveAll(dir)

outputDirAbsolutePath = dir

subDir := filepath.Join(dir, "subdir")
if err := os.Mkdir(subDir, 0o755); err != nil {
t.Fatalf("Failed to create subdirectory: %v", err)
}

files, err := readDirRecursively(dir)
if err != nil {
t.Fatalf("readDirRecursively returned an error: %v", err)
}

if len(files) != 0 {
t.Errorf("Expected %d directories, got %d", 0, len(files))
}
}

func TestReadDirRecursivelyWithGitSubmodule(t *testing.T) {
dir, err := os.MkdirTemp("", "testing")
if err != nil {
t.Fatalf("Failed to create temp directory: %v", err)
}
defer os.RemoveAll(dir)

outputDirAbsolutePath = dir

subDir := filepath.Join(dir, "subdir")
if err := os.Mkdir(subDir, 0o755); err != nil {
t.Fatalf("Failed to create subdirectory: %v", err)
}

gitDir := filepath.Join(subDir, ".git")
if err := os.Mkdir(gitDir, 0o755); err != nil {
t.Fatalf("Failed to create subdirectory: %v", err)
}

submoduleDir := filepath.Join(subDir, "submodule")
if err := os.Mkdir(submoduleDir, 0o755); err != nil {
t.Fatalf("Failed to create subdirectory: %v", err)
}

submoduleGitFile := filepath.Join(submoduleDir, ".git")
if _, err := os.Create(submoduleGitFile); err != nil {
t.Fatalf("Failed to create file: %v", err)
}

files, err := readDirRecursively(dir)
if err != nil {
t.Fatalf("readDirRecursively returned an error: %v", err)
}

if len(files) != 1 {
t.Errorf("Expected %d directories, got %d", 1, len(files))
}

if len(files) > 0 && files[0].Name() != "subdir" {
t.Errorf("Expected directory name 'subdir', got '%s'", files[0].Name())
}
}
15 changes: 0 additions & 15 deletions scripts/gitlab_cloud_integration_tests.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,21 +87,6 @@ else
exit 1
fi

# PRUNE AND PRESERVE DIR
ghorg clone $GITLAB_GROUP --token="${GITLAB_TOKEN}" --scm=gitlab --prune --preserve-dir
git init "${HOME}"/ghorg/"${GITLAB_GROUP}"/wayne-enterprises/wayne-industries/prunable
ghorg clone $GITLAB_GROUP --token="${GITLAB_TOKEN}" --scm=gitlab --prune --preserve-dir

if [ -e "${HOME}"/ghorg/"${GITLAB_GROUP}"/wayne-enterprises/wayne-industries/microservice ] && \
[ ! -e "${HOME}"/ghorg/"${GITLAB_GROUP}"/wayne-enterprises/wayne-industries/prunable ]
then
echo "Pass: gitlab org clone preserve dir, prune"
rm -rf "${HOME}/ghorg/${GITLAB_GROUP}"
else
echo "Fail: gitlab org clone preserve dir, prune"
exit 1
fi

# REPO NAME COLLISION
ghorg clone $GITLAB_GROUP_2 --token="${GITLAB_TOKEN}" --scm=gitlab

Expand Down
Loading