go.fuchsia.dev/infra@v0.0.0-20240507153436-9b593402251b/cmd/roller-configurator/validate_test.go

// Copyright 2023 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

package main

import (
	"context"
	"os"
	"path/filepath"
	"testing"

	"go.fuchsia.dev/infra/cmd/roller-configurator/proto"
)

var filesWithGitmodules = map[string]string{
	".gitmodules": `
		[submodule "path/to/submodule"]
		url = "https://example.com/asubmodule"
	`,
}

var filesWithJiriManifest = map[string]string{
	"path/to/jiri_manifest": `
		<?xml version="1.0" encoding="UTF-8"?>
		<manifest>
			<projects>
				<project name="foo-project"
						 remote="https://example.com/jiri-project"/>
			</projects>
			<packages>
				<package name="package1"/>
				<package name="package2"/>
			</packages>
		</manifest>
	`,
}

func TestValidate_valid(t *testing.T) {
	t.Parallel()

	testCases := []struct {
		name   string
		config *proto.Config
		files  map[string]string
	}{
		{
			name:   "empty",
			config: &proto.Config{},
		},
		{
			name: "submodule with interval schedule",
			config: &proto.Config{
				Rollers: []*proto.Roller{
					{
						ToRoll: &proto.Roller_Submodule{Submodule: &proto.GitSubmodule{
							Path: "path/to/submodule",
						}},
						Schedule: "with 24h interval",
					},
				},
			},
			files: filesWithGitmodules,
		},
		{
			name: "cipd ensure file with cron schedule",
			config: &proto.Config{
				Rollers: []*proto.Roller{
					{
						ToRoll: &proto.Roller_CipdEnsureFile{CipdEnsureFile: &proto.CIPDEnsureFile{
							Path: "path/to/cipd.ensure",
							Ref:  "foo",
						}},
						Schedule: "0/20 * * * *",
					},
				},
			},
			files: map[string]string{
				"path/to/cipd.ensure": ``,
			},
		},
		{
			name: "jiri project with notify emails",
			config: &proto.Config{
				Rollers: []*proto.Roller{
					{
						ToRoll: &proto.Roller_JiriProject{JiriProject: &proto.JiriProject{
							Manifest: "path/to/jiri_manifest",
							Project:  "foo-project",
						}},
						NotifyEmails: []string{
							"foo@example.com",
							"bar@example.com",
						},
					},
				},
				DefaultCheckoutJiriManifest: "manifest",
			},
			files: filesWithJiriManifest,
		},
		{
			name: "jiri packages",
			config: &proto.Config{
				Rollers: []*proto.Roller{
					{
						ToRoll: &proto.Roller_JiriPackages{JiriPackages: &proto.JiriPackages{
							Manifests: []*proto.JiriPackages_Manifest{
								{
									Path: "path/to/jiri_manifest",
									Packages: []string{
										"package1",
										"package2",
									},
								},
							},
						}},
					},
				},
				DefaultCheckoutJiriManifest: "manifest",
			},
			files: filesWithJiriManifest,
		},
	}

	for _, tc := range testCases {
		t.Run(tc.name, func(t *testing.T) {
			t.Parallel()

			repoRoot := t.TempDir()
			writeFiles(t, repoRoot, tc.files)

			err := validate(context.Background(), repoRoot, tc.config)
			if err != nil {
				t.Fatal(err)
			}
		})
	}
}

func TestValidate_invalid(t *testing.T) {
	t.Parallel()

	testCases := []struct {
		name   string
		config *proto.Config
		err    string
		files  map[string]string
	}{
		{
			name: "unnecessary default_checkout_jiri_manifest",
			config: &proto.Config{
				// Shouldn't be set unless `Rollers` contains any Jiri rollers.
				DefaultCheckoutJiriManifest: "manifest",
			},
			err: "default_checkout_jiri_manifest need not be set",
		},
		{
			name: "no entity to roll",
			config: &proto.Config{
				Rollers: []*proto.Roller{
					{},
				},
			},
			err: "entry 0 is missing an entity to roll",
		},
		{
			name: "invalid interval schedule",
			config: &proto.Config{
				Rollers: []*proto.Roller{
					{
						ToRoll: &proto.Roller_Submodule{Submodule: &proto.GitSubmodule{
							Path: "path/to/submodule",
						}},
						Schedule: "with blah",
					},
				},
			},
			files: filesWithGitmodules,
			err:   `invalid schedule "with blah"`,
		},
		{
			name: "invalid interval schedule duration",
			config: &proto.Config{
				Rollers: []*proto.Roller{
					{
						ToRoll: &proto.Roller_Submodule{Submodule: &proto.GitSubmodule{
							Path: "path/to/submodule",
						}},
						Schedule: "with 6f interval",
					},
				},
			},
			files: filesWithGitmodules,
			err:   `invalid duration in schedule "with 6f interval"`,
		},
		{
			name: "invalid cron schedule",
			config: &proto.Config{
				Rollers: []*proto.Roller{
					{
						ToRoll: &proto.Roller_Submodule{Submodule: &proto.GitSubmodule{
							Path: "path/to/submodule",
						}},
						Schedule: "foo * * * *",
					},
				},
			},
			files: filesWithGitmodules,
			err:   `invalid cron schedule "foo * * * *"`,
		},
		{
			name: "invalid notify email",
			config: &proto.Config{
				Rollers: []*proto.Roller{
					{
						ToRoll: &proto.Roller_Submodule{Submodule: &proto.GitSubmodule{
							Path: "path/to/submodule",
						}},
						NotifyEmails: []string{
							"valid@example.com",
							"not-an-email",
						},
					},
				},
			},
			files: filesWithGitmodules,
			err:   `invalid email "not-an-email"`,
		},
		{
			name: "submodule with no .gitmodules file",
			config: &proto.Config{
				Rollers: []*proto.Roller{
					{
						ToRoll: &proto.Roller_Submodule{Submodule: &proto.GitSubmodule{
							Path: "path/to/submodule",
						}},
					},
				},
			},
			err: "no .gitmodules file in repository root",
		},
		{
			name: "submodule with invalid .gitmodules file",
			config: &proto.Config{
				Rollers: []*proto.Roller{
					{
						ToRoll: &proto.Roller_Submodule{Submodule: &proto.GitSubmodule{
							Path: "path/to/submodule",
						}},
					},
				},
			},
			files: map[string]string{
				".gitmodules": `invalid`,
			},
			err: "invalid `git config --list --file .gitmodules` line: \"invalid\"",
		},
		{
			name: "submodule not listed in .gitmodules",
			config: &proto.Config{
				Rollers: []*proto.Roller{
					{
						ToRoll: &proto.Roller_Submodule{Submodule: &proto.GitSubmodule{
							Path: "path/to/INVALID",
						}},
					},
				},
			},
			files: map[string]string{
				".gitmodules": `
				[submodule "path/to/submodule"]
					url = "https://example.com/asubmodule"
				`,
			},
			err: `no such submodule "path/to/INVALID" listed in .gitmodules`,
		},
		{
			name: "missing CIPD ensure file",
			config: &proto.Config{
				Rollers: []*proto.Roller{
					{
						ToRoll: &proto.Roller_CipdEnsureFile{CipdEnsureFile: &proto.CIPDEnsureFile{
							Path: "path/to/cipd.ensure",
							Ref:  "foo",
						}},
					},
				},
			},
			err: "no such file: path/to/cipd.ensure",
		},
		{
			name: "missing jiri project manifest",
			config: &proto.Config{
				Rollers: []*proto.Roller{
					{
						ToRoll: &proto.Roller_JiriProject{JiriProject: &proto.JiriProject{
							Manifest: "path/to/manifest",
							Project:  "project-name",
						}},
					},
				},
			},
			err: "no such file: path/to/manifest",
		},
		{
			name: "missing jiri package manifest",
			config: &proto.Config{
				Rollers: []*proto.Roller{
					{
						ToRoll: &proto.Roller_JiriPackages{JiriPackages: &proto.JiriPackages{
							Manifests: []*proto.JiriPackages_Manifest{
								{
									Path: "path/to/manifest",
									Packages: []string{
										"package1",
										"package2",
									},
								},
							},
						}},
					},
				},
			},
			err: "no such file: path/to/manifest",
		},
		{
			name: "invalid jiri project",
			config: &proto.Config{
				Rollers: []*proto.Roller{
					{
						ToRoll: &proto.Roller_JiriProject{JiriProject: &proto.JiriProject{
							Manifest: "path/to/jiri_manifest",
							Project:  "not-a-project",
						}},
					},
				},
			},
			files: filesWithJiriManifest,
			err:   `no project "not-a-project" in manifest "path/to/jiri_manifest"`,
		},
		{
			name: "invalid jiri package",
			config: &proto.Config{
				Rollers: []*proto.Roller{
					{
						ToRoll: &proto.Roller_JiriPackages{JiriPackages: &proto.JiriPackages{
							Manifests: []*proto.JiriPackages_Manifest{
								{
									Path: "path/to/jiri_manifest",
									Packages: []string{
										"bad-package1",
										"bad-package2",
									},
								},
							},
						}},
					},
				},
			},
			files: filesWithJiriManifest,
			err:   `no package "bad-package1" in manifest "path/to/jiri_manifest"`,
		},
		{
			name: "jiri project roller with no default checkout manifest",
			config: &proto.Config{
				Rollers: []*proto.Roller{
					{
						ToRoll: &proto.Roller_JiriProject{JiriProject: &proto.JiriProject{
							Manifest: "path/to/jiri_manifest",
							Project:  "foo-project",
						}},
					},
				},
			},
			files: filesWithJiriManifest,
			err:   `default_checkout_jiri_manifest is required to enable jiri rollers`,
		},
		{
			name: "jiri package roller with no default checkout manifest",
			config: &proto.Config{
				Rollers: []*proto.Roller{
					{
						ToRoll: &proto.Roller_JiriPackages{JiriPackages: &proto.JiriPackages{
							Manifests: []*proto.JiriPackages_Manifest{
								{
									Path: "path/to/jiri_manifest",
									Packages: []string{
										"package1",
										"package2",
									},
								},
							},
						}},
					},
				},
			},
			files: filesWithJiriManifest,
			err:   `default_checkout_jiri_manifest is required to enable jiri rollers`,
		},
	}

	for _, tc := range testCases {
		t.Run(tc.name, func(t *testing.T) {
			t.Parallel()

			repoRoot := t.TempDir()
			writeFiles(t, repoRoot, tc.files)

			err := validate(context.Background(), repoRoot, tc.config)
			if err == nil {
				t.Fatalf("Expected an error: %s", tc.err)
			}
			if err.Error() != tc.err {
				t.Fatalf("Got error %q, expected %q", err, tc.err)
			}
		})
	}
}

func writeFiles(t *testing.T, rootDir string, files map[string]string) {
	for path, contents := range files {
		abspath := filepath.Join(rootDir, path)
		if err := os.MkdirAll(filepath.Dir(abspath), 0o700); err != nil {
			t.Fatal(err)
		}
		if err := os.WriteFile(abspath, []byte(contents), 0o600); err != nil {
			t.Fatal(err)
		}
	}
}