migrate

type CampaignModuleReport struct {
	Path                string               `yaml:"path"`
	WorktreeDir         string               `yaml:"worktree_dir,omitempty"`
	MigrationEnabled    bool                 `yaml:"migration_enabled"`
	PlanState           string               `yaml:"plan_state"`
	ChangedFiles        *int                 `yaml:"changed_files,omitempty"`
	ManifestChanged     bool                 `yaml:"manifest_changed"`
	PublishableManifest bool                 `yaml:"publishable_manifest,omitempty"`
	ReviewItems         int                  `yaml:"review_items"`
	MigrationReportPath string               `yaml:"migration_report_path,omitempty"`
	Verifications       []VerificationResult `yaml:"verifications,omitempty"`
	Status              string               `yaml:"status"`
}

type CampaignOptions struct {
	GitHubDir  string
	Ref        string
	ModuleRefs map[string]string
	Apply      bool
	Resume     bool
	Verify     Verification
	Commit     bool
	Push       bool
	PR         bool
	Merge      bool
	Parallel   int
	ReportDir  string

	// CloneURL overrides the canonical GitHub clone URL for a repository. It is
	// primarily useful for hermetic integration tests; normal campaigns use
	// https://<repository>.git.
	CloneURL func(repository string) string
}

type CampaignReport struct {
	SchemaVersion int                        `yaml:"schema_version"`
	Migration     ReportMigration            `yaml:"migration"`
	Status        string                     `yaml:"status"`
	SourceRoot    string                     `yaml:"source_root"`
	GitHubDir     string                     `yaml:"github_dir"`
	BaseRef       string                     `yaml:"base_ref"`
	Verification  Verification               `yaml:"verification"`
	Parallel      int                        `yaml:"parallel"`
	Repositories  []CampaignRepositoryReport `yaml:"repositories"`
}

type CampaignRepositoryReport struct {
	Repository     string                 `yaml:"repository"`
	CanonicalDir   string                 `yaml:"canonical_dir"`
	WorktreeDir    string                 `yaml:"worktree_dir"`
	Branch         string                 `yaml:"branch"`
	Ref            string                 `yaml:"ref"`
	Actions        []string               `yaml:"actions"`
	ChangedFiles   *[]string              `yaml:"changed_files,omitempty"`
	Modules        []CampaignModuleReport `yaml:"modules"`
	Commit         string                 `yaml:"commit,omitempty"`
	Pushed         bool                   `yaml:"pushed,omitempty"`
	PR             string                 `yaml:"pr,omitempty"`
	RequiredChecks []RemoteCheck          `yaml:"required_checks,omitempty"`
	Merged         bool                   `yaml:"merged,omitempty"`
}

type FileChange struct {
	Path           string   `json:"path"`
	Language       string   `json:"language"`
	OriginalSHA256 string   `json:"original_sha256"`
	Updated        []byte   `json:"-"`
	Steps          []string `json:"steps"`
}

type Finding struct {
	Path     string `json:"path"`
	Language string `json:"language"`
	RuleID   string `json:"rule_id"`
	Message  string `json:"message"`
	Lines    []int  `json:"lines"`
}

type GoModuleRelease struct {
	Path    string
	Version string
}

type GoModuleRequire struct {
	Path    string
	Version string
}

type Plan struct {
	MigrationID string       `json:"migration_id"`
	Changes     []FileChange `json:"changes"`
	Findings    []Finding    `json:"findings"`
}

type RemoteCheck struct {
	Name   string `yaml:"name"`
	Bucket string `yaml:"bucket"`
}

type Report struct {
	SchemaVersion int             `yaml:"schema_version"`
	Migration     ReportMigration `yaml:"migration"`
	Status        string          `yaml:"status"`
	Files         []ReportFile    `yaml:"files"`
	ReviewItems   []ReportFinding `yaml:"review_items,omitempty"`
}

type ReportFile struct {
	Root           string   `yaml:"root"`
	Path           string   `yaml:"path"`
	AbsolutePath   string   `yaml:"absolute_path"`
	Language       string   `yaml:"language"`
	Operations     []string `yaml:"operations"`
	OriginalSHA256 string   `yaml:"original_sha256"`
	GitDiffCommand string   `yaml:"git_diff_command"`
}

type ReportFinding struct {
	Root         string `yaml:"root"`
	Path         string `yaml:"path"`
	AbsolutePath string `yaml:"absolute_path"`
	Language     string `yaml:"language"`
	RuleID       string `yaml:"rule_id"`
	Message      string `yaml:"message"`
	Lines        []int  `yaml:"lines"`
}

type ReportMigration struct {
	ID     string `yaml:"id"`
	Title  string `yaml:"title,omitempty"`
	Format string `yaml:"format"`
}

type ReviewRule struct {
	ID             string
	Language       string
	Pattern        string
	ExcludePattern string
	Message        string
}

type Scope struct {
	Languages []string
	Include   []string
	Exclude   []string
}

type Spec struct {
	Format           string
	ID               string
	Title            string
	Scope            Scope
	Steps            []Step
	Review           []ReviewRule
	GoModuleRequires []GoModuleRequire
	GoModuleReleases []GoModuleRelease
}

type Step struct {
	Kind     string
	Language string

	From string
	To   string

	Import      string
	AddImport   string
	AddImportAs string
	Rewrites    map[string]string
}

type StructuralAdapter interface {
	Transform(source []byte, filename string, step Step) (updated []byte, changed bool, err error)
}

type Verification string

type VerificationResult struct {
	Command string `yaml:"command"`
	Passed  bool   `yaml:"passed"`
	Detail  string `yaml:"detail,omitempty"`
}