// Copyright 2024 Stefan Prodan.
// SPDX-License-Identifier: AGPL-3.0
package gitprovider
import (
"context"
"os"
"regexp"
"testing"
"github.com/Masterminds/semver/v3"
. "github.com/onsi/gomega"
"github.com/controlplaneio-fluxcd/flux-operator/internal/filtering"
)
func TestGitHubProvider_ListTags(t *testing.T) {
newConstraint := func(s string) *semver.Constraints {
c, err := semver.NewConstraint(s)
if err != nil {
panic(err)
}
return c
}
tests := []struct {
name string
opts Options
want []Result
wantErrMsg string
}{
{
name: "filters tags by semver",
opts: Options{
Token: os.Getenv("GITHUB_TOKEN"),
URL: "https://github.com/stefanprodan/podinfo",
Filters: filtering.Filters{
SemVer: newConstraint("> 6.0.1 < 6.1.0"),
},
},
want: []Result{
{
ID: "48955639",
SHA: "11cf36d83818e64aaa60d523ab6438258ebb6009",
Tag: "6.0.4",
},
{
ID: "48890102",
SHA: "ea292aa958c5e348266518af2261dc04d6270439",
Tag: "6.0.3",
},
{
ID: "48824565",
SHA: "693ffa9d28208c677738a0e2061f41694dfaa183",
Tag: "6.0.2",
},
},
},
{
name: "filters tags by semver and limit",
opts: Options{
Token: os.Getenv("GITHUB_TOKEN"),
URL: "https://github.com/stefanprodan/podinfo",
Filters: filtering.Filters{
SemVer: newConstraint("6.0.x"),
Limit: 1,
},
},
want: []Result{
{
ID: "48955639",
SHA: "11cf36d83818e64aaa60d523ab6438258ebb6009",
Tag: "6.0.4",
},
},
},
{
name: "filters tags no results",
opts: Options{
Token: os.Getenv("GITHUB_TOKEN"),
URL: "https://github.com/stefanprodan/podinfo",
Filters: filtering.Filters{
SemVer: newConstraint("0.0.x"),
},
},
want: []Result{},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
g := NewWithT(t)
provider, err := NewGitHubProvider(context.Background(), tt.opts)
g.Expect(err).NotTo(HaveOccurred())
got, err := provider.ListTags(context.Background(), tt.opts)
if len(tt.wantErrMsg) > 0 {
g.Expect(err).To(HaveOccurred())
g.Expect(err.Error()).To(ContainSubstring(tt.wantErrMsg))
return
}
g.Expect(err).NotTo(HaveOccurred())
g.Expect(got).To(BeEquivalentTo(tt.want))
})
}
}
func TestGitHubProvider_ListBranches(t *testing.T) {
tests := []struct {
name string
opts Options
want []Result
wantErrMsg string
}{
{
name: "filters branches by regex",
opts: Options{
Token: os.Getenv("GITHUB_TOKEN"),
URL: "https://github.com/fluxcd-testing/pr-testing",
Filters: filtering.Filters{
Include: regexp.MustCompile(`^stefanprodan-patch-.*`),
Exclude: regexp.MustCompile(`^stefanprodan-patch-4`),
},
},
want: []Result{
{
ID: "1433470881",
SHA: "2dd3a8d2088457e5cf991018edf13e25cbd61380",
Branch: "stefanprodan-patch-1",
},
{
ID: "1433536418",
SHA: "1e5aef14d38a8c67e5240308adf2935d6cdc2ec8",
Branch: "stefanprodan-patch-2",
},
{
ID: "1433601955",
SHA: "29d1d3a726e1e1f68b7cb60ac891cb83fa260ea9",
Branch: "stefanprodan-patch-3",
},
},
},
{
name: "filters branches by limit",
opts: Options{
Token: os.Getenv("GITHUB_TOKEN"),
URL: "https://github.com/fluxcd-testing/pr-testing",
Filters: filtering.Filters{
Include: regexp.MustCompile(`^stefanprodan-patch-.*`),
Limit: 1,
},
},
want: []Result{
{
ID: "1433470881",
SHA: "2dd3a8d2088457e5cf991018edf13e25cbd61380",
Branch: "stefanprodan-patch-1",
},
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
g := NewWithT(t)
provider, err := NewGitHubProvider(context.Background(), tt.opts)
g.Expect(err).NotTo(HaveOccurred())
got, err := provider.ListBranches(context.Background(), tt.opts)
if len(tt.wantErrMsg) > 0 {
g.Expect(err).To(HaveOccurred())
g.Expect(err.Error()).To(ContainSubstring(tt.wantErrMsg))
return
}
g.Expect(err).NotTo(HaveOccurred())
g.Expect(got).To(BeEquivalentTo(tt.want))
})
}
}
func TestGitHubProvider_ListRequests(t *testing.T) {
tests := []struct {
name string
opts Options
want []Result
wantErrMsg string
}{
{
name: "all prs",
opts: Options{
Token: os.Getenv("GITHUB_TOKEN"),
URL: "https://github.com/fluxcd-testing/pr-testing",
},
want: []Result{
{
ID: "5",
SHA: "f43c54d06a19335cb8be4607ef9a05a3b20fb485",
Title: "test5: Update README.md",
Author: "stefanprodan",
Branch: "feat/5",
Labels: []string{},
},
{
ID: "4",
SHA: "80332195632fe293564ff563344032cf4c75af45",
Title: "test4: Update README.md",
Author: "stefanprodan",
Branch: "stefanprodan-patch-4",
Labels: []string{"documentation", "enhancement"},
},
{
ID: "3",
SHA: "29d1d3a726e1e1f68b7cb60ac891cb83fa260ea9",
Title: "test3: Update README.md",
Author: "stefanprodan",
Branch: "stefanprodan-patch-3",
Labels: []string{"documentation"},
},
{
ID: "2",
SHA: "1e5aef14d38a8c67e5240308adf2935d6cdc2ec8",
Title: "test2: Update README.md",
Author: "stefanprodan",
Branch: "stefanprodan-patch-2",
Labels: []string{"enhancement"},
},
{
ID: "1",
SHA: "2dd3a8d2088457e5cf991018edf13e25cbd61380",
Title: "test1: Update README.md",
Author: "stefanprodan",
Branch: "stefanprodan-patch-1",
Labels: []string{"enhancement"},
},
},
},
{
name: "filters prs by labels and limit",
opts: Options{
Token: os.Getenv("GITHUB_TOKEN"),
URL: "https://github.com/fluxcd-testing/pr-testing",
Filters: filtering.Filters{
Limit: 2,
Labels: []string{"enhancement"},
},
},
want: []Result{
{
ID: "4",
SHA: "80332195632fe293564ff563344032cf4c75af45",
Title: "test4: Update README.md",
Author: "stefanprodan",
Branch: "stefanprodan-patch-4",
Labels: []string{"documentation", "enhancement"},
},
{
ID: "2",
SHA: "1e5aef14d38a8c67e5240308adf2935d6cdc2ec8",
Title: "test2: Update README.md",
Author: "stefanprodan",
Branch: "stefanprodan-patch-2",
Labels: []string{"enhancement"},
},
},
},
{
name: "filters prs by branches",
opts: Options{
Token: os.Getenv("GITHUB_TOKEN"),
URL: "https://github.com/fluxcd-testing/pr-testing",
Filters: filtering.Filters{
Include: regexp.MustCompile(`^feat/.*`),
},
},
want: []Result{
{
ID: "5",
SHA: "f43c54d06a19335cb8be4607ef9a05a3b20fb485",
Title: "test5: Update README.md",
Author: "stefanprodan",
Branch: "feat/5",
Labels: []string{},
},
},
},
{
name: "repo not found",
opts: Options{
Token: os.Getenv("GITHUB_TOKEN"),
URL: "https://github.com/fluxcd-testing/invalid",
},
wantErrMsg: "404 Not Found",
},
{
name: "wrong token",
opts: Options{
Token: "wrong-token",
URL: "https://github.com/fluxcd-testing/pr-testing",
},
wantErrMsg: "401 Bad credentials",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
g := NewWithT(t)
provider, err := NewGitHubProvider(context.Background(), tt.opts)
g.Expect(err).NotTo(HaveOccurred())
got, err := provider.ListRequests(context.Background(), tt.opts)
if len(tt.wantErrMsg) > 0 {
g.Expect(err).To(HaveOccurred())
g.Expect(err.Error()).To(ContainSubstring(tt.wantErrMsg))
return
}
g.Expect(err).NotTo(HaveOccurred())
g.Expect(got).To(BeEquivalentTo(tt.want))
})
}
}
