feat(dev): add Docker development CLI (#6495)
This commit is contained in:
1 parent
d58a47b776
commit
018f84f80d
27 files changed
+4048
-7
No files matched your search
@@ -0,0 +1,199 @@
|
||||
package gh
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"os/exec"
|
||||
"strings"
|
||||
"sync"
|
||||
"time"
|
||||
)
|
||||
|
||||
const Repo = "homarr-labs/homarr"
|
||||
const prCacheTTL = 5 * time.Minute
|
||||
|
||||
var prListCache = struct {
|
||||
sync.Mutex
|
||||
entries map[int]cachedPRs
|
||||
}{entries: make(map[int]cachedPRs)}
|
||||
|
||||
type cachedPRs struct {
|
||||
prs []PR
|
||||
fetchedAt time.Time
|
||||
}
|
||||
|
||||
func isBot(login string) bool {
|
||||
return strings.HasSuffix(login, "[bot]") || strings.HasPrefix(login, "app/")
|
||||
}
|
||||
|
||||
type PR struct {
|
||||
Number int `json:"number"`
|
||||
Title string `json:"title"`
|
||||
Author string `json:"author"`
|
||||
HeadRef string `json:"headRefName"`
|
||||
HeadSHA string `json:"headRefOid"`
|
||||
CIState string `json:"ciState"`
|
||||
IsDraft bool `json:"isDraft"`
|
||||
UpdatedAt string `json:"updatedAt"`
|
||||
}
|
||||
|
||||
type rawPR struct {
|
||||
Number int `json:"number"`
|
||||
Title string `json:"title"`
|
||||
IsDraft bool `json:"isDraft"`
|
||||
Author struct {
|
||||
Login string `json:"login"`
|
||||
} `json:"author"`
|
||||
HeadRefName string `json:"headRefName"`
|
||||
HeadRefOID string `json:"headRefOid"`
|
||||
UpdatedAt string `json:"updatedAt"`
|
||||
StatusCheckRollup []rawCheck `json:"statusCheckRollup"`
|
||||
}
|
||||
|
||||
type rawCheck struct {
|
||||
Status string `json:"status"`
|
||||
Conclusion string `json:"conclusion"`
|
||||
State string `json:"state"`
|
||||
}
|
||||
|
||||
func rollupState(checks []rawCheck) string {
|
||||
if len(checks) == 0 {
|
||||
return "NONE"
|
||||
}
|
||||
failed, pending := 0, 0
|
||||
for _, c := range checks {
|
||||
if c.State != "" {
|
||||
switch c.State {
|
||||
case "SUCCESS":
|
||||
case "PENDING", "EXPECTED":
|
||||
pending++
|
||||
default:
|
||||
failed++
|
||||
}
|
||||
continue
|
||||
}
|
||||
if c.Status != "COMPLETED" {
|
||||
pending++
|
||||
continue
|
||||
}
|
||||
switch c.Conclusion {
|
||||
case "SUCCESS", "SKIPPED", "NEUTRAL":
|
||||
default:
|
||||
failed++
|
||||
}
|
||||
}
|
||||
if failed > 0 {
|
||||
return "FAILURE"
|
||||
}
|
||||
if pending > 0 {
|
||||
return "PENDING"
|
||||
}
|
||||
return "SUCCESS"
|
||||
}
|
||||
|
||||
func ListPRs(ctx context.Context, limit int, includeBots bool) ([]PR, error) {
|
||||
return listPRs(ctx, limit, includeBots, false)
|
||||
}
|
||||
|
||||
func RefreshPRs(ctx context.Context, limit int, includeBots bool) ([]PR, error) {
|
||||
return listPRs(ctx, limit, includeBots, true)
|
||||
}
|
||||
|
||||
func listPRs(ctx context.Context, limit int, includeBots, refresh bool) ([]PR, error) {
|
||||
cached, fetchedAt := cachedPRList(limit)
|
||||
if !refresh && !fetchedAt.IsZero() && time.Since(fetchedAt) < prCacheTTL {
|
||||
return filterPRs(cached, includeBots), nil
|
||||
}
|
||||
|
||||
out, err := exec.CommandContext(ctx, "gh", "pr", "list",
|
||||
"--repo", Repo,
|
||||
"--state", "open",
|
||||
"--limit", fmt.Sprint(limit),
|
||||
"--json", "number,title,author,headRefName,headRefOid,updatedAt,isDraft,statusCheckRollup",
|
||||
).CombinedOutput()
|
||||
if err != nil {
|
||||
err = commandError(err, out)
|
||||
if len(cached) > 0 {
|
||||
return filterPRs(cached, includeBots), fmt.Errorf("%w; showing cached PRs from %s", err, fetchedAt.Format(time.Kitchen))
|
||||
}
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var raws []rawPR
|
||||
if err := json.Unmarshal(out, &raws); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
prs := make([]PR, 0, len(raws))
|
||||
for _, r := range raws {
|
||||
prs = append(prs, PR{
|
||||
Number: r.Number,
|
||||
Title: r.Title,
|
||||
Author: r.Author.Login,
|
||||
HeadRef: r.HeadRefName,
|
||||
HeadSHA: r.HeadRefOID,
|
||||
CIState: rollupState(r.StatusCheckRollup),
|
||||
IsDraft: r.IsDraft,
|
||||
UpdatedAt: r.UpdatedAt,
|
||||
})
|
||||
}
|
||||
storePRList(limit, prs)
|
||||
return filterPRs(prs, includeBots), nil
|
||||
}
|
||||
|
||||
func cachedPRList(limit int) ([]PR, time.Time) {
|
||||
prListCache.Lock()
|
||||
defer prListCache.Unlock()
|
||||
entry := prListCache.entries[limit]
|
||||
return append([]PR(nil), entry.prs...), entry.fetchedAt
|
||||
}
|
||||
|
||||
func storePRList(limit int, prs []PR) {
|
||||
prListCache.Lock()
|
||||
defer prListCache.Unlock()
|
||||
prListCache.entries[limit] = cachedPRs{prs: append([]PR(nil), prs...), fetchedAt: time.Now()}
|
||||
}
|
||||
|
||||
func filterPRs(prs []PR, includeBots bool) []PR {
|
||||
filtered := make([]PR, 0, len(prs))
|
||||
for _, pr := range prs {
|
||||
if includeBots || !isBot(pr.Author) {
|
||||
filtered = append(filtered, pr)
|
||||
}
|
||||
}
|
||||
return filtered
|
||||
}
|
||||
|
||||
func commandError(err error, output []byte) error {
|
||||
detail := strings.TrimSpace(string(output))
|
||||
if detail == "" {
|
||||
return err
|
||||
}
|
||||
return fmt.Errorf("%s: %w", detail, err)
|
||||
}
|
||||
|
||||
func GetPR(ctx context.Context, number int) (*PR, error) {
|
||||
out, err := exec.CommandContext(ctx, "gh", "pr", "view", fmt.Sprint(number),
|
||||
"--repo", Repo,
|
||||
"--json", "number,title,author,headRefName,headRefOid,updatedAt,isDraft,statusCheckRollup",
|
||||
).CombinedOutput()
|
||||
if err != nil {
|
||||
return nil, commandError(err, out)
|
||||
}
|
||||
|
||||
var r rawPR
|
||||
if err := json.Unmarshal(out, &r); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return &PR{
|
||||
Number: r.Number,
|
||||
Title: r.Title,
|
||||
Author: r.Author.Login,
|
||||
HeadRef: r.HeadRefName,
|
||||
HeadSHA: r.HeadRefOID,
|
||||
CIState: rollupState(r.StatusCheckRollup),
|
||||
IsDraft: r.IsDraft,
|
||||
UpdatedAt: r.UpdatedAt,
|
||||
}, nil
|
||||
}
|
||||
@@ -0,0 +1,91 @@
|
||||
package gh
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"os"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
func TestIsBot(t *testing.T) {
|
||||
tests := []struct {
|
||||
login string
|
||||
want bool
|
||||
}{
|
||||
{login: "app/homarr-renovate", want: true},
|
||||
{login: "dependabot[bot]", want: true},
|
||||
{login: "ajnart", want: false},
|
||||
}
|
||||
|
||||
for _, test := range tests {
|
||||
if got := isBot(test.login); got != test.want {
|
||||
t.Errorf("isBot(%q) = %v, want %v", test.login, got, test.want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestRollupStateHandlesChecksAndStatuses(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
checks []rawCheck
|
||||
want string
|
||||
}{
|
||||
{name: "check success", checks: []rawCheck{{Status: "COMPLETED", Conclusion: "SUCCESS"}}, want: "SUCCESS"},
|
||||
{name: "status failure", checks: []rawCheck{{State: "FAILURE"}}, want: "FAILURE"},
|
||||
{name: "status pending", checks: []rawCheck{{State: "PENDING"}}, want: "PENDING"},
|
||||
}
|
||||
|
||||
for _, test := range tests {
|
||||
t.Run(test.name, func(t *testing.T) {
|
||||
if got := rollupState(test.checks); got != test.want {
|
||||
t.Fatalf("rollupState() = %q, want %q", got, test.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestCachedPRListFiltersBotsWithoutMutatingCache(t *testing.T) {
|
||||
limit := 9876
|
||||
storePRList(limit, []PR{{Number: 1, Author: "developer"}, {Number: 2, Author: "bot[bot]"}})
|
||||
|
||||
prs, fetchedAt := cachedPRList(limit)
|
||||
if time.Since(fetchedAt) >= prCacheTTL {
|
||||
t.Fatal("new cache entry is already expired")
|
||||
}
|
||||
if filtered := filterPRs(prs, false); len(filtered) != 1 || filtered[0].Number != 1 {
|
||||
t.Fatalf("filtered PRs = %#v", filtered)
|
||||
}
|
||||
if unfiltered := filterPRs(prs, true); len(unfiltered) != 2 {
|
||||
t.Fatalf("unfiltered PR count = %d, want 2", len(unfiltered))
|
||||
}
|
||||
}
|
||||
|
||||
func TestCommandErrorIncludesGitHubOutput(t *testing.T) {
|
||||
err := commandError(errors.New("exit status 1"), []byte("GraphQL: API rate limit exceeded\n"))
|
||||
if !strings.Contains(err.Error(), "API rate limit exceeded") {
|
||||
t.Fatalf("error = %q", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestListPRsExcludesBotsIntegration(t *testing.T) {
|
||||
if os.Getenv("HOMARR_INTEGRATION_TEST") != "1" {
|
||||
t.Skip("set HOMARR_INTEGRATION_TEST=1 to query GitHub")
|
||||
}
|
||||
|
||||
prs, err := ListPRs(t.Context(), 50, false)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if len(prs) == 0 {
|
||||
t.Fatal("expected at least one human-authored open PR")
|
||||
}
|
||||
for _, pr := range prs {
|
||||
if isBot(pr.Author) {
|
||||
t.Fatalf("bot PR was not filtered: #%d by %s", pr.Number, pr.Author)
|
||||
}
|
||||
if pr.HeadSHA == "" {
|
||||
t.Fatalf("PR #%d has no head SHA", pr.Number)
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user