Revert "Rename catalog funcs and update their godocs."

This reverts commit 230cc72a8b.

Signed-off-by: James Hewitt <james.hewitt@uk.ibm.com>

registry/storage/catalog.go

@@ -3,7 +3,6 @@ package storage
 import (
 	"context"
 	"errors"
-	"fmt"
 	"io"
 	"path"
 	"sort"
@@ -14,12 +13,10 @@ import (
 )
 
 var (
-	// ErrStopReposWalk is used as a return value to indicate that the repository path walk
+	ErrStopRec = errors.New("Stopped the recursion for getting repositories")
-	// should be stopped. It's not returned as an error by any function.
-	ErrStopReposWalk = errors.New("stop repos walk")
 )
 
-// Returns a list or a partial list of repositories in the registry.
+// Returns a list, or partial list, of repositories in the registry.
 // Because it's a quite expensive operation, it should only be used when building up
 // an initial set of repositories.
 func (reg *registry) Repositories(ctx context.Context, repos []string, last string) (n int, err error) {
@@ -27,7 +24,7 @@ func (reg *registry) Repositories(ctx context.Context, repos []string, last stri
 	var foundRepos []string
 
 	if len(repos) == 0 {
-		return -1, errors.New("no repos requested")
+		return 0, errors.New("no space in slice")
 	}
 
 	root, err := pathFor(repositoriesRootPathSpec{})
@@ -35,14 +32,14 @@ func (reg *registry) Repositories(ctx context.Context, repos []string, last stri
 		return 0, err
 	}
 
-	err = reg.walkRepos(ctx, root, last, func(repoPath string) error {
+	err = reg.getRepositories(ctx, root, last, func(repoPath string) error {
 		// this is placed before the append,
-		// so that we will get an extra repo if
+		// so that we will get a extra repo if
-		// any. This ensures that we do not return
+		// any. This assures that we do not return
 		// io.EOF without it being the last record.
 		if len(foundRepos) == len(repos) {
 			finishedWalk = true
-			return ErrStopReposWalk
+			return ErrStopRec
 		}
 
 		foundRepos = append(foundRepos, repoPath)
@@ -69,7 +66,7 @@ func (reg *registry) Enumerate(ctx context.Context, ingester func(string) error)
 		return err
 	}
 
-	return reg.walkRepos(ctx, root, "", ingester)
+	return reg.getRepositories(ctx, root, "", ingester)
 }
 
 // Remove removes a repository from storage
@@ -82,11 +79,12 @@ func (reg *registry) Remove(ctx context.Context, name reference.Named) error {
 	return reg.driver.Delete(ctx, repoDir)
 }
 
-// walkRepos walks paths rooted in root calling fn for each found repo path.
+// getRepositories is a helper function for getRepositoriesRec calls
-// Paths are walked in a lexical order which makes the output deterministic.
+// the function fn with a repository path, if the current path looked
-// If last is not an empty string it walks all repo paths. Otherwise
+// at is a repository and is lexicographically after last. It is possible
-// it returns when last repoPath is found.
+// to return driver.ErrSkipDir, if there is no interest in any repositories
-func (reg *registry) walkRepos(ctx context.Context, root, last string, fn func(repoPath string) error) error {
+// under the given `repoPath`, or call ErrStopRec if the recursion should stop.
+func (reg *registry) getRepositories(ctx context.Context, root, last string, fn func(repoPath string) error) error {
 	midFn := fn
 
 	// middleware func to exclude the `last` repo
@@ -102,16 +100,16 @@ func (reg *registry) walkRepos(ctx context.Context, root, last string, fn func(r
 
 	// call our recursive func, with the midFn and the start path
 	// of where we want to find repositories.
-	err := reg.walkReposPath(ctx, root, root, last, midFn)
+	err := reg.getRepositoriesRec(ctx, root, root, last, midFn)
-	if err == ErrStopReposWalk {
+	if err == ErrStopRec {
 		return nil
 	}
 	return err
 }
 
-// walkReposPath walks through all folders in `lookPath`,
+// getRepositoriesRec recurse through all folders it the `lookPath`,
-// looking for repositories. See walkRepos for more detailed description.
+// there it will try to find repositories. See getRepositories for more.
-func (reg *registry) walkReposPath(ctx context.Context, root, lookPath, last string, fn func(repoPath string) error) error {
+func (reg *registry) getRepositoriesRec(ctx context.Context, root, lookPath, last string, fn func(repoPath string) error) error {
 	// ensure that the current path is a dir, otherwise we just return
 	if f, err := reg.blobStore.driver.Stat(ctx, lookPath); err != nil || !f.IsDir() {
 		if err != nil {
@@ -130,25 +128,25 @@ func (reg *registry) walkReposPath(ctx context.Context, root, lookPath, last str
 	sort.Strings(children)
 
 	if last != "" {
-		splitLast := strings.Split(last, "/")
+		splitLasts := strings.Split(last, "/")
 
-		// call the next iteration of walkReposPath if any, but
+		// call the next iteration of getRepositoriesRec if any, but
 		// exclude the current one.
-		if len(splitLast) > 1 {
+		if len(splitLasts) > 1 {
-			if err := reg.walkReposPath(ctx, root, lookPath+"/"+splitLast[0], strings.Join(splitLast[1:], "/"), fn); err != nil {
+			if err := reg.getRepositoriesRec(ctx, root, lookPath+"/"+splitLasts[0], strings.Join(splitLasts[1:], "/"), fn); err != nil {
 				return err
 			}
 		}
 
 		// find current last path in our children
-		n := sort.SearchStrings(children, lookPath+"/"+splitLast[0])
+		n := sort.SearchStrings(children, lookPath+"/"+splitLasts[0])
-		if n == len(children) || children[n] != lookPath+"/"+splitLast[0] {
+		if n == len(children) || children[n] != lookPath+"/"+splitLasts[0] {
-			return fmt.Errorf("%q repository not found", last)
+			return errors.New("the provided 'last' repositories does not exists")
 		}
 
 		// if this is not a final `last` (there are more `/` left)
 		// then exclude the current index, else include it
-		if len(splitLast) > 1 {
+		if len(splitLasts) > 1 {
 			children = children[n+1:]
 		} else {
 			children = children[n:]
@@ -158,15 +156,15 @@ func (reg *registry) walkReposPath(ctx context.Context, root, lookPath, last str
 	for _, child := range children {
 		_, file := path.Split(child)
 
-		if file == "_manifests" {
+		if file == "_manifest" {
 			if err := fn(strings.TrimPrefix(lookPath, root+"/")); err != nil {
 				if err == driver.ErrSkipDir {
 					break
 				}
 				return err
 			}
-		} else if !strings.HasPrefix(file, "_") {
+		} else if file[0] != '_' {
-			if err := reg.walkReposPath(ctx, root, child, "", fn); err != nil {
+			if err := reg.getRepositoriesRec(ctx, root, child, "", fn); err != nil {
 				return err
 			}
 		}

registry/storage/catalog_test.go

@@ -240,3 +240,88 @@ func TestCatalogWalkError(t *testing.T) {
 		t.Errorf("Expected catalog driver list error")
 	}
 }
+<<<<<<< HEAD
+
+func BenchmarkPathCompareEqual(B *testing.B) {
+	B.StopTimer()
+	pp := randomPath(100)
+	// make a real copy
+	ppb := append([]byte{}, []byte(pp)...)
+	a, b := pp, string(ppb)
+
+	B.StartTimer()
+	for i := 0; i < B.N; i++ {
+		lessPath(a, b)
+	}
+}
+
+func BenchmarkPathCompareNotEqual(B *testing.B) {
+	B.StopTimer()
+	a, b := randomPath(100), randomPath(100)
+	B.StartTimer()
+
+	for i := 0; i < B.N; i++ {
+		lessPath(a, b)
+	}
+}
+
+func BenchmarkPathCompareNative(B *testing.B) {
+	B.StopTimer()
+	a, b := randomPath(100), randomPath(100)
+	B.StartTimer()
+
+	for i := 0; i < B.N; i++ {
+		c := a < b
+		_ = c && false
+	}
+}
+
+func BenchmarkPathCompareNativeEqual(B *testing.B) {
+	B.StopTimer()
+	pp := randomPath(100)
+	a, b := pp, pp
+	B.StartTimer()
+
+	for i := 0; i < B.N; i++ {
+		c := a < b
+		_ = c && false
+	}
+}
+
+var (
+	filenameChars  = []byte("abcdefghijklmnopqrstuvwxyz0123456789")
+	separatorChars = []byte("._-")
+)
+
+func randomPath(length int64) string {
+	path := "/"
+	for int64(len(path)) < length {
+		chunkLength := rand.Int63n(length-int64(len(path))) + 1
+		chunk := randomFilename(chunkLength)
+		path += chunk
+		remaining := length - int64(len(path))
+		if remaining == 1 {
+			path += randomFilename(1)
+		} else if remaining > 1 {
+			path += "/"
+		}
+	}
+	return path
+}
+
+func randomFilename(length int64) string {
+	b := make([]byte, length)
+	wasSeparator := true
+	for i := range b {
+		if !wasSeparator && i < len(b)-1 && rand.Intn(4) == 0 {
+			b[i] = separatorChars[rand.Intn(len(separatorChars))]
+			wasSeparator = true
+		} else {
+			b[i] = filenameChars[rand.Intn(len(filenameChars))]
+			wasSeparator = false
+		}
+	}
+	return string(b)
+}
+=======
+>>>>>>> 27bd92bd (fix bug in catalog last param and optimized it)