Skip to content

fix: preserve selected runner repository membership #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
intel352 merged 1 commit into from
Oct 3, 2026
Merged

fix: preserve selected runner repository membership #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions internal/runner_policy.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ type policyGroup struct {

type policyGroupPatch struct {
Name string `json:"name"`
Visibility string `json:"visibility"`
Visibility string `json:"visibility,omitempty"`
AllowsPublicRepositories bool `json:"allows_public_repositories"`
RestrictedToWorkflows bool `json:"restricted_to_workflows"`
SelectedWorkflows []string `json:"selected_workflows"`
Expand Down Expand Up @@ -801,7 +801,12 @@ func (r *runnerPolicyReconciler) write(ctx context.Context, d RunnerPolicyDesire
switch step {
case 1:
g := after.Target.Group
_, err = r.client.request(ctx, http.MethodPatch, groupPath, policyGroupPatch{g.Name, g.Visibility, g.AllowsPublicRepositories, g.RestrictedToWorkflows, g.SelectedWorkflows}, nil, http.StatusOK)
patch := policyGroupPatch{g.Name, g.Visibility, g.AllowsPublicRepositories, g.RestrictedToWorkflows, g.SelectedWorkflows}
// Sending unchanged visibility can clear GitHub's selected repositories.
if g.Visibility == before.Target.Group.Visibility {
patch.Visibility = ""
}
_, err = r.client.request(ctx, http.MethodPatch, groupPath, patch, nil, http.StatusOK)
case 2:
_, err = r.client.request(ctx, http.MethodPut, groupPath+"/repositories", struct {
IDs []int64 `json:"selected_repository_ids"`
Expand Down
153 changes: 149 additions & 4 deletions internal/runner_policy_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ type policyAPIFake struct {
interruptWrite string
beforeWrite bool
blockReads bool
keepPatchRepos bool
}

func newPolicyAPIFake(t *testing.T) *policyAPIFake {
Expand Down Expand Up @@ -84,18 +85,30 @@ func (f *policyAPIFake) serve(w http.ResponseWriter, r *http.Request) {
switch {
case r.Method == "PATCH" && path == "/orgs/GoCodeAlone/actions/runner-groups/2":
var patch struct {
Name string `json:"name"`
policyGroupPatch
Name string `json:"name"`
Visibility *string `json:"visibility"`
AllowsPublicRepositories bool `json:"allows_public_repositories"`
RestrictedToWorkflows bool `json:"restricted_to_workflows"`
SelectedWorkflows []string `json:"selected_workflows"`
}
if json.NewDecoder(r.Body).Decode(&patch) != nil {
decoder := json.NewDecoder(r.Body)
decoder.DisallowUnknownFields()
if decoder.Decode(&patch) != nil {
w.WriteHeader(400)
return
}
if patch.Name == "" || patch.Name != f.group.Name {
w.WriteHeader(http.StatusUnprocessableEntity)
return
}
f.group.Visibility, f.group.AllowsPublicRepositories, f.group.RestrictedToWorkflows, f.group.SelectedWorkflows = patch.Visibility, patch.AllowsPublicRepositories, patch.RestrictedToWorkflows, patch.SelectedWorkflows
if patch.Visibility != nil {
f.group.Visibility = *patch.Visibility
// Sending visibility resets selection even when its value is unchanged.
if !f.keepPatchRepos {
f.repoIDs = []int64{}
}
}
f.group.AllowsPublicRepositories, f.group.RestrictedToWorkflows, f.group.SelectedWorkflows = patch.AllowsPublicRepositories, patch.RestrictedToWorkflows, patch.SelectedWorkflows
case r.Method == "PUT" && path == "/orgs/GoCodeAlone/actions/runner-groups/2/repositories":
var put struct {
IDs []int64 `json:"selected_repository_ids"`
Expand Down Expand Up @@ -231,6 +244,138 @@ func TestRunnerPolicyGroupPatchPreservesRequiredName(t *testing.T) {
}
}

func TestRunnerPolicyVisibilityPatchSelectionAndResponseLoss(t *testing.T) {
for _, visibility := range []string{"selected", "all", "private"} {
for _, lost := range []string{"", "PATCH /orgs/GoCodeAlone/actions/runner-groups/2", "PUT /orgs/GoCodeAlone/actions/runner-groups/2/repositories"} {
if visibility == "selected" && strings.HasPrefix(lost, "PUT ") {
continue
}
t.Run(visibility+"/"+lost, func(t *testing.T) {
f := newPolicyAPIFake(t)
f.group.Visibility = visibility
f.repoIDs = []int64{17}
f.loseOnce = lost
dir := t.TempDir()
r := policyReconcilerFixture(t, f, dir)
if _, err := r.Plan(context.Background(), "visibility", runnerPolicyFixture()); err != nil {
t.Fatal(err)
}
result, err := r.Apply(context.Background(), "visibility")
if err != nil {
t.Fatalf("PATCH reset selected repository membership: %v; repos=%v writes=%v", err, f.repoIDs, f.writes)
}
if result.Phase != "applied" || !reflect.DeepEqual(f.repoIDs, []int64{17}) || f.variable == nil || !f.group.RestrictedToWorkflows {
t.Fatal("apply did not prove exact selection and variable readback")
}
writes := len(f.writes)
r = policyReconcilerFixture(t, f, dir)
if _, err := r.Apply(context.Background(), "visibility"); err != nil || len(f.writes) != writes {
t.Fatalf("confirmed response-loss retry repeated mutation: %v", err)
}
f.loseOnce = "DELETE /repos/GoCodeAlone/workflow-compute/actions/variables/WORKFLOW_COMPUTE_STAGING_URL"
result, err = r.Rollback(context.Background(), "visibility")
if err != nil || result.Phase != "rolled-back-restrictive" || f.variable != nil || !reflect.DeepEqual(f.repoIDs, []int64{17}) || f.group.Visibility != "selected" || !f.group.RestrictedToWorkflows {
t.Fatalf("rollback broadened or lost exact selection: %+v %v", result, err)
}
if _, err := policyReconcilerFixture(t, f, dir).Rollback(context.Background(), "visibility"); err != nil || len(f.writes) != writes+1 {
t.Fatalf("response-loss rollback retry repeated mutation: %v", err)
}
patches, puts := 0, 0
for _, write := range f.writes {
switch write {
case "PATCH /orgs/GoCodeAlone/actions/runner-groups/2":
patches++
case "PUT /orgs/GoCodeAlone/actions/runner-groups/2/repositories":
puts++
}
}
wantPuts := 1
if visibility == "selected" {
wantPuts = 0
}
if patches != 1 || puts != wantPuts {
t.Fatalf("unexpected mutation sequence: patches=%d puts=%d wantPuts=%d", patches, puts, wantPuts)
}
})
}
}
}

func TestRunnerPolicyVisibilityTransitionUnexpectedSelectionDenied(t *testing.T) {
for _, visibility := range []string{"all", "private"} {
t.Run(visibility, func(t *testing.T) {
f := newPolicyAPIFake(t)
f.group.Visibility = visibility
f.repoIDs = []int64{17}
f.keepPatchRepos = true
dir := t.TempDir()
r := policyReconcilerFixture(t, f, dir)
if _, err := r.Plan(context.Background(), "unmodeled", runnerPolicyFixture()); err != nil {
t.Fatal(err)
}
if _, err := r.Apply(context.Background(), "unmodeled"); err == nil || !strings.Contains(err.Error(), "readback does not equal") {
t.Fatalf("unmodeled selection after visibility transition accepted: %v", err)
}
if len(f.writes) != 1 || f.variable != nil {
t.Fatal("unmodeled visibility readback reached repository or variable write")
}
r = policyReconcilerFixture(t, f, dir)
if _, err := r.Apply(context.Background(), "unmodeled"); err == nil {
t.Fatal("unmodeled interrupted state was accepted on retry")
}
if _, err := r.Rollback(context.Background(), "unmodeled"); err == nil || len(f.writes) != 1 {
t.Fatal("rollback accepted unmodeled interrupted state")
}
})
}
}

func TestRunnerPolicyInterruptedSelectionResetRemainsDenied(t *testing.T) {
f := newPolicyAPIFake(t)
f.repoIDs = []int64{17}
dir := t.TempDir()
r := policyReconcilerFixture(t, f, dir)
d := runnerPolicyFixture()
if _, err := r.Plan(context.Background(), "reset", d); err != nil {
t.Fatal(err)
}
root, err := r.openAudit()
if err != nil {
t.Fatal(err)
}
defer func() { _ = root.Close() }()
plan, _, err := r.load(root, "reset")
if err != nil {
t.Fatal(err)
}
after := *plan.Before
after.Target.Group = policyDesiredState(*plan.Before, d).Target.Group
hash, err := policyHash(after)
if err != nil {
t.Fatal(err)
}
intent := runnerPolicyEvent{TransactionID: "reset", Phase: "write-intent", Step: 1, Before: plan.Before, After: &after, BeforeHash: plan.BeforeHash, AfterHash: hash}
if err := r.append(root, intent); err != nil {
t.Fatal(err)
}
f.group = after.Target.Group
f.repoIDs = []int64{}
path := filepath.Join(dir, runnerPolicyAuditFile)
before, err := os.ReadFile(path)
if err != nil {
t.Fatal(err)
}
for _, operation := range []func(context.Context, string) (RunnerPolicyResult, error){r.Apply, r.Rollback} {
if _, err := operation(context.Background(), "reset"); err == nil || !strings.Contains(err.Error(), "unrecognized readback") {
t.Fatalf("released interrupted reset state was rebound or auto-repaired: %v", err)
}
}
journal, err := os.ReadFile(path)
if err != nil || !bytes.Equal(journal, before) || len(f.writes) != 0 || f.variable != nil {
t.Fatal("denial changed journal authority or API state")
}
}

func TestRunnerPolicyDuplicateInitialAuthorityDenied(t *testing.T) {
f := newPolicyAPIFake(t)
dir := t.TempDir()
Expand Down
Loading