// Copyright 2023 Harness, Inc. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package api import ( "bytes" "context" "fmt" "strings" "github.com/harness/gitness/git/command" "github.com/harness/gitness/git/sha" ) type Branch struct { Name string SHA sha.SHA Commit *Commit } type BranchFilter struct { Query string Page int32 PageSize int32 Sort GitReferenceField Order SortOrder IncludeCommit bool } // BranchPrefix base dir of the branch information file store on git. const BranchPrefix = "refs/heads/" // GetBranch gets an existing branch. func (g *Git) GetBranch( ctx context.Context, repoPath string, branchName string, ) (*Branch, error) { if repoPath == "" { return nil, ErrRepositoryPathEmpty } if branchName == "" { return nil, ErrBranchNameEmpty } ref := GetReferenceFromBranchName(branchName) commit, err := GetCommit(ctx, repoPath, ref+"^{commit}") //nolint:goconst if err != nil { return nil, fmt.Errorf("failed to find the commit for the branch: %w", err) } return &Branch{ Name: branchName, SHA: commit.SHA, Commit: commit, }, nil } // HasBranches returns true iff there's at least one branch in the repo (any branch) // NOTE: This is different from repo.Empty(), // as it doesn't care whether the existing branch is the default branch or not. func (g *Git) HasBranches( ctx context.Context, repoPath string, ) (bool, error) { if repoPath == "" { return false, ErrRepositoryPathEmpty } // repo has branches IFF there's at least one commit that is reachable via a branch // (every existing branch points to a commit) cmd := command.New("rev-list", command.WithFlag("--max-count", "1"), command.WithFlag("--branches"), ) output := &bytes.Buffer{} if err := cmd.Run(ctx, command.WithDir(repoPath), command.WithStdout(output)); err != nil { return false, processGitErrorf(err, "failed to trigger rev-list command") } return strings.TrimSpace(output.String()) == "", nil } func (g *Git) IsBranchExist(ctx context.Context, repoPath, name string) (bool, error) { cmd := command.New("show-ref", command.WithFlag("--verify", BranchPrefix+name), ) err := cmd.Run(ctx, command.WithDir(repoPath), ) if err != nil { return false, fmt.Errorf("failed to check if branch '%s' exist: %w", name, err) } return true, nil }