|
| 1 | +package store |
| 2 | + |
| 3 | +import ( |
| 4 | + "fmt" |
| 5 | + "os" |
| 6 | + "path/filepath" |
| 7 | + "strings" |
| 8 | + |
| 9 | + "sigs.k8s.io/maintainers/experiments/keptain/pkg/model" |
| 10 | + "sigs.k8s.io/yaml" |
| 11 | +) |
| 12 | + |
| 13 | +// Repository represents a KEP repository |
| 14 | +type Repository struct { |
| 15 | + basePath string |
| 16 | + keps map[string]*model.KEP |
| 17 | +} |
| 18 | + |
| 19 | +// NewRepository creates a new KEP repository instance |
| 20 | +func NewRepository(basePath string) (*Repository, error) { |
| 21 | + r := &Repository{ |
| 22 | + basePath: basePath, |
| 23 | + keps: make(map[string]*model.KEP), |
| 24 | + } |
| 25 | + if err := r.loadKEPs(); err != nil { |
| 26 | + return nil, fmt.Errorf("error loading KEPs: %v", err) |
| 27 | + } |
| 28 | + return r, nil |
| 29 | +} |
| 30 | + |
| 31 | +func (r *Repository) loadKEPs() error { |
| 32 | + // Walk the KEPs directory and load all KEPs |
| 33 | + if err := filepath.Walk(r.basePath, func(path string, info os.FileInfo, err error) error { |
| 34 | + if err != nil { |
| 35 | + return err |
| 36 | + } |
| 37 | + if info.IsDir() { |
| 38 | + return nil |
| 39 | + } |
| 40 | + |
| 41 | + // We assume there's a metadata file for each KEP called kep.yaml |
| 42 | + if filepath.Base(path) != "kep.yaml" { |
| 43 | + return nil |
| 44 | + } |
| 45 | + |
| 46 | + relativePath, err := filepath.Rel(r.basePath, path) |
| 47 | + if err != nil { |
| 48 | + return fmt.Errorf("error getting relative path: %w", err) |
| 49 | + } |
| 50 | + |
| 51 | + dir := filepath.Dir(path) |
| 52 | + relativeDir := filepath.Dir(relativePath) |
| 53 | + |
| 54 | + b, err := os.ReadFile(path) |
| 55 | + if err != nil { |
| 56 | + return fmt.Errorf("error reading KEP file: %w", err) |
| 57 | + } |
| 58 | + kep, err := r.parseKEPFile(b) |
| 59 | + if err != nil { |
| 60 | + // Log error but continue processing other KEPs |
| 61 | + return fmt.Errorf("error parsing KEP %q: %w", path, err) |
| 62 | + } |
| 63 | + |
| 64 | + // use the (repo-relative) directory as the identifier for the KEP |
| 65 | + kep.Path = relativeDir |
| 66 | + |
| 67 | + // See if we have a README.md file |
| 68 | + { |
| 69 | + readme := filepath.Join(dir, "README.md") |
| 70 | + readmeBytes, err := os.ReadFile(readme) |
| 71 | + if err != nil { |
| 72 | + if !os.IsNotExist(err) { |
| 73 | + return fmt.Errorf("error getting README.md: %w", err) |
| 74 | + } |
| 75 | + return nil |
| 76 | + } |
| 77 | + |
| 78 | + if err == nil { |
| 79 | + kep.TextContents = string(readmeBytes) |
| 80 | + kep.TextURL = fmt.Sprintf("https://github.com/kubernetes/enhancements/blob/master/%s", filepath.Join(relativeDir, "README.md")) |
| 81 | + } |
| 82 | + } |
| 83 | + r.keps[kep.Path] = kep |
| 84 | + return nil |
| 85 | + }); err != nil { |
| 86 | + return fmt.Errorf("error walking KEPs: %w", err) |
| 87 | + } |
| 88 | + |
| 89 | + return nil |
| 90 | +} |
| 91 | + |
| 92 | +// ListKEPs returns all KEPs in the repository |
| 93 | +// If query is provided, it will filter the KEPs based on the query |
| 94 | +func (r *Repository) ListKEPs(query string) ([]*model.KEP, error) { |
| 95 | + var ret []*model.KEP |
| 96 | + for _, kep := range r.keps { |
| 97 | + // Filter KEPs if search query is provided |
| 98 | + match := true |
| 99 | + if query != "" { |
| 100 | + query = strings.ToLower(query) |
| 101 | + if strings.Contains(strings.ToLower(kep.Title), query) || |
| 102 | + strings.Contains(strings.ToLower(kep.Number), query) || |
| 103 | + containsAuthor(kep.Authors, query) { |
| 104 | + match = true |
| 105 | + } |
| 106 | + } |
| 107 | + |
| 108 | + if match { |
| 109 | + ret = append(ret, kep) |
| 110 | + } |
| 111 | + } |
| 112 | + return ret, nil |
| 113 | +} |
| 114 | + |
| 115 | +func containsAuthor(authors []string, query string) bool { |
| 116 | + for _, author := range authors { |
| 117 | + if strings.Contains(strings.ToLower(author), query) { |
| 118 | + return true |
| 119 | + } |
| 120 | + } |
| 121 | + return false |
| 122 | +} |
| 123 | + |
| 124 | +// GetKEP returns a specific KEP by number |
| 125 | +func (r *Repository) GetKEP(path string) (*model.KEP, error) { |
| 126 | + kep, ok := r.keps[path] |
| 127 | + if ok { |
| 128 | + return kep, nil |
| 129 | + } |
| 130 | + return nil, fmt.Errorf("KEP %s not found", path) |
| 131 | +} |
| 132 | + |
| 133 | +// kepFile is the format used in the KEP file. |
| 134 | +type kepFile struct { |
| 135 | + Title string `json:"title"` |
| 136 | + Number string `json:"kep-number"` |
| 137 | + Authors []string `json:"authors"` |
| 138 | + OwningSig string `json:"owning-sig"` |
| 139 | + ParticipatingSigs []string `json:"participating-sigs"` |
| 140 | + Reviewers []string `json:"reviewers"` |
| 141 | + Approvers []string `json:"approvers"` |
| 142 | + Editor string `json:"editor"` |
| 143 | + CreationDate string `json:"creation-date"` |
| 144 | + LastUpdated string `json:"last-updated"` |
| 145 | + Status string `json:"status"` |
| 146 | + SeeAlso []string `json:"see-also"` |
| 147 | + Replaces []string `json:"replaces"` |
| 148 | + SupersededBy []string `json:"superseded-by"` |
| 149 | +} |
| 150 | + |
| 151 | +// parseKEPFile parses a KEP yaml file |
| 152 | +func (r *Repository) parseKEPFile(data []byte) (*model.KEP, error) { |
| 153 | + |
| 154 | + var kep kepFile |
| 155 | + if err := yaml.Unmarshal(data, &kep); err != nil { |
| 156 | + return nil, fmt.Errorf("error parsing KEP yaml: %v", err) |
| 157 | + } |
| 158 | + |
| 159 | + // Extract additional metadata from the yaml |
| 160 | + var rawMap map[string]interface{} |
| 161 | + if err := yaml.Unmarshal(data, &rawMap); err != nil { |
| 162 | + return nil, fmt.Errorf("error parsing KEP metadata: %v", err) |
| 163 | + } |
| 164 | + |
| 165 | + out := &model.KEP{ |
| 166 | + Title: kep.Title, |
| 167 | + Number: kep.Number, |
| 168 | + Authors: kep.Authors, |
| 169 | + Status: kep.Status, |
| 170 | + } |
| 171 | + return out, nil |
| 172 | +} |
0 commit comments