test: repo_branch_test.go is flaky #28318

AdamMajer · 2023-12-01T13:16:00Z

Description

Every time I run this test, it seems to fail locally but succeed remotely.

2023/12/01 13:55:50 ...dules/git/command.go:275:Run() [E] git command is broken: /usr/bin/git -c protocol.version=2 -c credential.helper=, broken args: -test                                 
2023/12/01 13:55:50 ...dules/git/command.go:275:Run() [E] git command is broken: /usr/bin/git -c protocol.version=2 -c credential.helper=, broken args: --test                                
61ab7345a1a3bbc590068ccae37b8515cfc5843c                                                       
61ab7345a1a3bbc590068ccae37b8515cfc5843c                                                       
--- FAIL: TestRepository_GetBranches (0.00s)                                                                                                                                                  
    repo_branch_test.go:24:                                                                    
                Error Trace:    /home/adamm/work/alp/gitea/gitea/modules/git/repo_branch_test.go:24                                                                                           
                Error:          elements differ                                                
                                                                                               
                                extra elements in list A:               
                                ([]interface {}) (len=1) {                                     
                                 (string) (len=6) "master"                                     
                                }                                                              
                                                                                               
                                                                                               
                                extra elements in list B:                                      
                                ([]interface {}) (len=1) {                                     
                                 (string) (len=7) "branch1"                                    
                                }                                                              
                                                                                               
                                                                                               
                                listA:                                                         
                                ([]string) (len=2) {                                           
                                 (string) (len=6) "master",                                                                                                                                   
                                 (string) (len=7) "branch2"                                    
                                }                                                                                                                                                             
                                                                                                                                                                                              
                                                                                               
                                listB:                                                         
                                ([]string) (len=2) {                       
                                 (string) (len=7) "branch1",                                   
                                 (string) (len=7) "branch2"            
                                }                                                              
                Test:           TestRepository_GetBranches
FAIL
Test failed: run test failed, ExitCode=1
FAIL    code.gitea.io/gitea/modules/git 0.464s

Gitea Version

main

Can you reproduce the bug on the Gitea demo site?

Yes

Log Gist

No response

Screenshots

No response

Git Version

git version 2.43.0

Operating System

openSUSE Tumbleweed

How are you running Gitea?

N/A

Database

None

The text was updated successfully, but these errors were encountered:

lng2020 · 2023-12-04T09:23:50Z

I can test it locally. Have you tried to figure out why you failed? You may inspect the bare repo under modules/git/tests/repos/repo1_bare.

Running tool: /usr/bin/go test -timeout 30s -run ^TestRepository_GetBranches$ code.gitea.io/gitea/modules/git -tags sqlite,sqlite_unlock_notify -v

=== RUN   TestRepository_GetBranches
--- PASS: TestRepository_GetBranches (0.01s)
PASS
ok  	code.gitea.io/gitea/modules/git	0.124s

lunny · 2023-12-04T09:34:17Z

Maybe you can check your git config under gitea's home directory.

AdamMajer · 2023-12-04T09:38:27Z

It seems it's gogit related. I assume it's assuming that there is some order to git branch listing. Is there suppose to be one?

> /usr/bin/go test -timeout 30s -tags sqlite,sqlite_unlock_notify -run ^TestRepository_GetBranches$ code.gitea.io/gitea/modules/git
ok      code.gitea.io/gitea/modules/git (cached)


> /usr/bin/go test -timeout 30s -tags sqlite,sqlite_unlock_notify,gogit -run ^TestRepository_GetBranches$ code.gitea.io/gitea/modules/git
--- FAIL: TestRepository_GetBranches (0.00s)
    repo_branch_test.go:24: 
                Error Trace:    /home/adamm/work/alp/gitea/gitea/modules/git/repo_branch_test.go:24
                Error:          elements differ
                            
                                extra elements in list A:
                                ([]interface {}) (len=1) {
                                 (string) (len=6) "master"
                                }
                            
                            
                                extra elements in list B:
                                ([]interface {}) (len=1) {
                                 (string) (len=7) "branch1"
                                }
                            
                            
                                listA:
                                ([]string) (len=2) {
                                 (string) (len=6) "master",
                                 (string) (len=7) "branch2"
                                }
                            
                            
                                listB:
                                ([]string) (len=2) {
                                 (string) (len=7) "branch1",
                                 (string) (len=7) "branch2"
                                }
                Test:           TestRepository_GetBranches
FAIL
Test failed: run test failed, ExitCode=1
FAIL    code.gitea.io/gitea/modules/git 0.066s
FAIL

AdamMajer · 2023-12-04T09:48:07Z

Maybe you can check your git config under gitea's home directory.

It's just gitea checkout. The failure only happens with gogit. I have v5@v5.9.0 which seems to be what gitea requires anyway.

[core]
        repositoryformatversion = 0
        filemode = true
        bare = false
        logallrefupdates = true

lng2020 · 2023-12-04T09:49:37Z

Yes. It's about the file sequence in gogit. PR to make this test more robust is welcome.

AdamMajer · 2023-12-04T10:26:13Z

Looking at the nogogit implementation,

// GetBranchNames returns branches from the repository, skipping "skip" initial branches and
// returning at most "limit" branches, or all branches if "limit" is 0.
func (repo *Repository) GetBranchNames(skip, limit int) ([]string, int, error) {
	return callShowRef(repo.Ctx, repo.Path, BranchPrefix, TrustedCmdArgs{BranchPrefix, "--sort=-committerdate"}, skip, limit)
}

which means the problem is not gogit itself, it's more the expectation of sort order. This also hints at the solution.

nogogit GetBranchNames() lists branches sorted in reverse commit date order. On the other hand the gogit implementation doesn't apply any ordering resulting in unpredictable behaviour. In my case, the unit tests requiring particular order fail repo_branch_test.go:24: Error Trace: ./gitea/modules/git/repo_branch_test.go:24 Error: elements differ extra elements in list A: ([]interface {}) (len=1) { (string) (len=6) "master" } extra elements in list B: ([]interface {}) (len=1) { (string) (len=7) "branch1" } listA: ([]string) (len=2) { (string) (len=6) "master", (string) (len=7) "branch2" } listB: ([]string) (len=2) { (string) (len=7) "branch1", (string) (len=7) "branch2" } Test: TestRepository_GetBranches To fix this, we sort branches based on their commit date in gogit implementation. Fixes: go-gitea#28318

@AdamMajer

Backport #28348 by @AdamMajer nogogit GetBranchNames() lists branches sorted in reverse commit date order. On the other hand the gogit implementation doesn't apply any ordering resulting in unpredictable behaviour. In my case, the unit tests requiring particular order fail repo_branch_test.go:24: Error Trace: ./gitea/modules/git/repo_branch_test.go:24 Error: elements differ extra elements in list A: ([]interface {}) (len=1) { (string) (len=6) "master" } extra elements in list B: ([]interface {}) (len=1) { (string) (len=7) "branch1" } listA: ([]string) (len=2) { (string) (len=6) "master", (string) (len=7) "branch2" } listB: ([]string) (len=2) { (string) (len=7) "branch1", (string) (len=7) "branch2" } Test: TestRepository_GetBranches To fix this, we sort branches based on their commit date in gogit implementation. Fixes: #28318 Co-authored-by: Adam Majer <amajer@suse.de>

@AdamMajer

…gitea#28386) Backport go-gitea#28348 by @AdamMajer nogogit GetBranchNames() lists branches sorted in reverse commit date order. On the other hand the gogit implementation doesn't apply any ordering resulting in unpredictable behaviour. In my case, the unit tests requiring particular order fail repo_branch_test.go:24: Error Trace: ./gitea/modules/git/repo_branch_test.go:24 Error: elements differ extra elements in list A: ([]interface {}) (len=1) { (string) (len=6) "master" } extra elements in list B: ([]interface {}) (len=1) { (string) (len=7) "branch1" } listA: ([]string) (len=2) { (string) (len=6) "master", (string) (len=7) "branch2" } listB: ([]string) (len=2) { (string) (len=7) "branch1", (string) (len=7) "branch2" } Test: TestRepository_GetBranches To fix this, we sort branches based on their commit date in gogit implementation. Fixes: go-gitea#28318 Co-authored-by: Adam Majer <amajer@suse.de> (cherry picked from commit 272ae03)

AdamMajer added the type/bug label Dec 1, 2023

lng2020 added the issue/needs-feedback For bugs, we need more details. For features, the feature must be described in more detail label Dec 4, 2023

lng2020 removed the issue/needs-feedback For bugs, we need more details. For features, the feature must be described in more detail label Dec 4, 2023

AdamMajer mentioned this issue Dec 4, 2023

Make gogit Repository.GetBranchNames consistent #28348

Merged

techknowlogick closed this as completed in #28348 Dec 7, 2023

GiteaBot mentioned this issue Dec 7, 2023

Make gogit Repository.GetBranchNames consistent (#28348) #28386

Merged

github-actions bot locked as resolved and limited conversation to collaborators Jan 22, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test: repo_branch_test.go is flaky #28318

test: repo_branch_test.go is flaky #28318

AdamMajer commented Dec 1, 2023

lng2020 commented Dec 4, 2023 •

edited

Loading

lunny commented Dec 4, 2023

AdamMajer commented Dec 4, 2023

AdamMajer commented Dec 4, 2023

lng2020 commented Dec 4, 2023 •

edited

Loading

AdamMajer commented Dec 4, 2023

test: repo_branch_test.go is flaky #28318

test: repo_branch_test.go is flaky #28318

Comments

AdamMajer commented Dec 1, 2023

Description

Gitea Version

Can you reproduce the bug on the Gitea demo site?

Log Gist

Screenshots

Git Version

Operating System

How are you running Gitea?

Database

lng2020 commented Dec 4, 2023 • edited Loading

lunny commented Dec 4, 2023

AdamMajer commented Dec 4, 2023

AdamMajer commented Dec 4, 2023

lng2020 commented Dec 4, 2023 • edited Loading

AdamMajer commented Dec 4, 2023

lng2020 commented Dec 4, 2023 •

edited

Loading

lng2020 commented Dec 4, 2023 •

edited

Loading