workflow-pr: maintainership parsing

This commit is contained in:
Adam Majer 2024-11-28 17:10:26 +01:00
parent 21f7da2257
commit 0331346025
2 changed files with 125 additions and 68 deletions

View File

@ -2,7 +2,6 @@ package main
import ( import (
"encoding/json" "encoding/json"
"errors"
"src.opensuse.org/autogits/common" "src.opensuse.org/autogits/common"
) )
@ -11,14 +10,14 @@ import (
const ProjectKey = "*" const ProjectKey = "*"
type MaintainershipMap map[string]interface{} type MaintainershipMap map[string][]string
type GiteaMaintainershipInterface interface { type GiteaMaintainershipInterface interface {
FetchMaintainershipFile(org, prj, branch string) ([]byte, error) FetchMaintainershipFile(org, prj, branch string) ([]byte, error)
} }
func MaintainerListForProject(gitea GiteaMaintainershipInterface, org, branch string) ([]string, error) { func parseMaintainerhipData(gitea GiteaMaintainershipInterface, org, pkg, branch string) (MaintainershipMap, error) {
data, err := gitea.FetchMaintainershipFile(org, common.DefaultGitPrj, branch) data, err := gitea.FetchMaintainershipFile(org, pkg, branch)
if err != nil || data == nil { if err != nil || data == nil {
return nil, err return nil, err
} }
@ -28,35 +27,41 @@ func MaintainerListForProject(gitea GiteaMaintainershipInterface, org, branch st
return nil, err return nil, err
} }
return maintainer, nil
}
func MaintainerListForProject(gitea GiteaMaintainershipInterface, org, branch string) ([]string, error) {
maintainer, err := parseMaintainerhipData(gitea, org, common.DefaultGitPrj, branch)
if err != nil {
return nil, err
}
m, found := maintainer[ProjectKey] m, found := maintainer[ProjectKey]
if !found { if !found {
return nil, nil return nil, nil
} }
invalidTypeErr := errors.New("Invalid type") return m, nil
switch m.(type) {
case []interface{}:
maintainers := make([]string, 0)
for _, v := range m.([]interface{}) {
if _, ok := v.(string); !ok {
return nil, invalidTypeErr
}
maintainers = append(maintainers, v.(string))
}
return maintainers, nil
case string:
return []string{m.(string)}, nil
default:
return nil, invalidTypeErr
}
} }
func MaintainerListForPackage(gitea GiteaMaintainershipInterface, org, pkg, branch string) ([]string, error) { func MaintainerListForPackage(gitea GiteaMaintainershipInterface, org, pkg, branch string) ([]string, error) {
_, err := gitea.FetchMaintainershipFile(org, pkg, branch) maintainer, err := parseMaintainerhipData(gitea, org, pkg, branch)
if err != nil { if err != nil {
return nil, err return nil, err
} }
return []string{}, nil
pkgMaintainers := maintainer[pkg]
prjMaintainers := maintainer[ProjectKey]
prjMaintainer:
for _, prjm := range prjMaintainers {
for i := range pkgMaintainers {
if pkgMaintainers[i] == prjm {
continue prjMaintainer
}
}
pkgMaintainers = append(pkgMaintainers, prjm)
}
return pkgMaintainers, nil
} }

View File

@ -10,34 +10,18 @@ import (
) )
func TestMaintainership(t *testing.T) { func TestMaintainership(t *testing.T) {
MaintainershipFile := []byte(`
{
"*": ["user1", "user2"]
}
`)
SinglePrjMaintainershipFile := []byte(` allocateMaintainershipInterface := func(t *testing.T) *mock_main.MockGiteaMaintainershipInterface {
{ t.Parallel()
"*": "user"
}
`)
BrokenPrjMaintainershipFile := []byte(`
{
"*": ["user", 4]
}
`)
SingleBrokenPrjMaintainershipFile := []byte(`
{
"*": 4
}
`)
t.Run("No maintainer in empty package", func(t *testing.T) {
ctl := gomock.NewController(t) ctl := gomock.NewController(t)
mi := mock_main.NewMockGiteaMaintainershipInterface(ctl) mi := mock_main.NewMockGiteaMaintainershipInterface(ctl)
return mi
}
t.Run("No maintainer in empty package", func(t *testing.T) {
mi := allocateMaintainershipInterface(t)
mi.EXPECT().FetchMaintainershipFile("foo", "goo", "bar").Return(nil, nil) mi.EXPECT().FetchMaintainershipFile("foo", "goo", "bar").Return(nil, nil)
m, err := MaintainerListForPackage(mi, "foo", "goo", "bar") m, err := MaintainerListForPackage(mi, "foo", "goo", "bar")
@ -47,8 +31,7 @@ func TestMaintainership(t *testing.T) {
}) })
t.Run("No maintainer for empty projects", func(t *testing.T) { t.Run("No maintainer for empty projects", func(t *testing.T) {
ctl := gomock.NewController(t) mi := allocateMaintainershipInterface(t)
mi := mock_main.NewMockGiteaMaintainershipInterface(ctl)
mi.EXPECT().FetchMaintainershipFile("foo", common.DefaultGitPrj, "bar").Return(nil, nil) mi.EXPECT().FetchMaintainershipFile("foo", common.DefaultGitPrj, "bar").Return(nil, nil)
@ -66,8 +49,7 @@ func TestMaintainership(t *testing.T) {
}) })
t.Run("Error in MaintainerListForPackage when remote has an error", func(t *testing.T) { t.Run("Error in MaintainerListForPackage when remote has an error", func(t *testing.T) {
ctl := gomock.NewController(t) mi := allocateMaintainershipInterface(t)
mi := mock_main.NewMockGiteaMaintainershipInterface(ctl)
err := errors.New("some error here") err := errors.New("some error here")
mi.EXPECT().FetchMaintainershipFile("foo", "goo", "bar").Return(nil, err) mi.EXPECT().FetchMaintainershipFile("foo", "goo", "bar").Return(nil, err)
@ -82,9 +64,9 @@ func TestMaintainership(t *testing.T) {
t.Error("Unexpected error received", err) t.Error("Unexpected error received", err)
} }
}) })
t.Run("Error in MaintainerListForProject when remote has an error", func(t *testing.T) { t.Run("Error in MaintainerListForProject when remote has an error", func(t *testing.T) {
ctl := gomock.NewController(t) mi := allocateMaintainershipInterface(t)
mi := mock_main.NewMockGiteaMaintainershipInterface(ctl)
err := errors.New("some error here") err := errors.New("some error here")
mi.EXPECT().FetchMaintainershipFile("foo", common.DefaultGitPrj, "bar").Return(nil, err) mi.EXPECT().FetchMaintainershipFile("foo", common.DefaultGitPrj, "bar").Return(nil, err)
@ -101,10 +83,13 @@ func TestMaintainership(t *testing.T) {
}) })
t.Run("Multiple project maintainers", func(t *testing.T) { t.Run("Multiple project maintainers", func(t *testing.T) {
ctl := gomock.NewController(t) mi := allocateMaintainershipInterface(t)
mi := mock_main.NewMockGiteaMaintainershipInterface(ctl)
mi.EXPECT().FetchMaintainershipFile("foo", common.DefaultGitPrj, "bar").Return(MaintainershipFile, nil) mi.EXPECT().FetchMaintainershipFile("foo", common.DefaultGitPrj, "bar").Return([]byte(`
{
"*": ["user1", "user2"]
}
`), nil)
m, err := MaintainerListForProject(mi, "foo", "bar") m, err := MaintainerListForProject(mi, "foo", "bar")
if len(m) != 2 || err != nil { if len(m) != 2 || err != nil {
@ -117,10 +102,13 @@ func TestMaintainership(t *testing.T) {
}) })
t.Run("Single project maintainer", func(t *testing.T) { t.Run("Single project maintainer", func(t *testing.T) {
ctl := gomock.NewController(t) mi := allocateMaintainershipInterface(t)
mi := mock_main.NewMockGiteaMaintainershipInterface(ctl)
mi.EXPECT().FetchMaintainershipFile("foo", common.DefaultGitPrj, "bar").Return(SinglePrjMaintainershipFile, nil) mi.EXPECT().FetchMaintainershipFile("foo", common.DefaultGitPrj, "bar").Return([]byte(`
{
"*": ["user"]
}
`), nil)
m, err := MaintainerListForProject(mi, "foo", "bar") m, err := MaintainerListForProject(mi, "foo", "bar")
if len(m) != 1 || err != nil { if len(m) != 1 || err != nil {
@ -133,26 +121,90 @@ func TestMaintainership(t *testing.T) {
}) })
t.Run("Invalid list of project maintainers", func(t *testing.T) { t.Run("Invalid list of project maintainers", func(t *testing.T) {
ctl := gomock.NewController(t) mi := allocateMaintainershipInterface(t)
mi := mock_main.NewMockGiteaMaintainershipInterface(ctl)
mi.EXPECT().FetchMaintainershipFile("foo", common.DefaultGitPrj, "bar").Return(BrokenPrjMaintainershipFile, nil) mi.EXPECT().FetchMaintainershipFile("foo", common.DefaultGitPrj, "bar").Return([]byte(`
{
"*": ["user", 4]
}
`), nil)
m, err := MaintainerListForProject(mi, "foo", "bar") m, err := MaintainerListForProject(mi, "foo", "bar")
if len(m) != 0 || err.Error() != "Invalid type" { if len(m) != 0 || err == nil {
t.Error("Invalid number of maintainers for project", err) t.Error("Invalid number of maintainers for project", err)
} }
}) })
t.Run("Invalid list of project maintainers", func(t *testing.T) { t.Run("Invalid list of project maintainers", func(t *testing.T) {
ctl := gomock.NewController(t) mi := allocateMaintainershipInterface(t)
mi := mock_main.NewMockGiteaMaintainershipInterface(ctl)
mi.EXPECT().FetchMaintainershipFile("foo", common.DefaultGitPrj, "bar").Return(SingleBrokenPrjMaintainershipFile, nil) mi.EXPECT().FetchMaintainershipFile("foo", common.DefaultGitPrj, "bar").Return([]byte(`
{
"*": 4
}
`), nil)
_, err := MaintainerListForProject(mi, "foo", "bar") _, err := MaintainerListForProject(mi, "foo", "bar")
if err.Error() != "Invalid type" { if err == nil {
t.Error("Invalid number of maintainers for project", err) t.Error("Invalid number of maintainers for project", err)
} }
}) })
t.Run("Multiple package maintainers", func(t *testing.T) {
mi := allocateMaintainershipInterface(t)
mi.EXPECT().FetchMaintainershipFile("foo", "pkg", "bar").Return([]byte(`
{
"pkg": ["user1", "user2"],
"*": ["user1", "user3"]
}
`), nil)
m, err := MaintainerListForPackage(mi, "foo", "pkg", "bar")
if len(m) != 3 || err != nil {
t.Error("Invalid number of maintainers for package", m)
}
if m[0] != "user1" || m[1] != "user2" || m[2] != "user3" {
t.Error("Can't find expected users. Found", m)
}
})
t.Run("No package maintainers and only project maintainer", func(t *testing.T) {
mi := allocateMaintainershipInterface(t)
mi.EXPECT().FetchMaintainershipFile("foo", "pkg0", "bar").Return([]byte(`
{
"pkg": ["user1", "user2"],
"*": ["user1", "user3"]
}
`), nil)
m, err := MaintainerListForPackage(mi, "foo", "pkg0", "bar")
if len(m) != 2 || err != nil {
t.Error("Invalid number of maintainers for package", m)
}
if m[0] != "user1" || m[1] != "user3" {
t.Error("Can't find expected users. Found", m)
}
})
t.Run("Invalid list of package maintainers", func(t *testing.T) {
mi := allocateMaintainershipInterface(t)
mi.EXPECT().FetchMaintainershipFile("foo", "pkg", "bar").Return([]byte(`
{
"pkg": 3,
"*": ["user", 4]
}
`), nil)
m, err := MaintainerListForPackage(mi, "foo", "pkg", "bar")
if len(m) != 0 || err == nil {
t.Error("Invalid number of maintainers for project", err)
}
})
t.Parallel()
} }