Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
38 changes: 38 additions & 0 deletions .github/workflows/generate-ownership.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Fetch and generate ownership information

on:
workflow_dispatch: {}

jobs:
fetch-owners:
runs-on: ubuntu-latest
steps:
- name: Checkout repo
uses: actions/checkout@v4
- name: Checkout shared workflows
uses: actions/checkout@v4
with:
repository: grafana/shared-workflows
path: shared-workflows
- name: Copy Shared Actions
run: |
mkdir -p /home/runner/work/plugins-private/plugins-private/shared-workflows
cp -r $GITHUB_WORKSPACE/shared-workflows/* /home/runner/work/plugins-private/plugins-private/shared-workflows
- name: Get IAP Token
id: get-secrets
uses: ./shared-workflows/actions/get-vault-secrets
with:
# Secrets placed in the ci/common/<path> path in Vault
common_secrets: |
GCP_IAP_SERVICE_ACCOUNT_KEY_DEV=grafana-com-iap:gcp_iap_service_account_key_ops
- name: gcloud-iap-auth-dev
run: |
printenv GCP_IAP_SERVICE_ACCOUNT_KEY_DEV > /tmp/gcp_service_account_key.json
gcloud auth activate-service-account --key-file=/tmp/gcp_service_account_key.json
gcloud auth print-identity-token \
--audiences="194555723165-aftshfqa32nig79trcrh96ha94ta46jd.apps.googleusercontent.com" \
--project "grafanalabs-global" \
--quiet \
--verbosity=error > /tmp/iap.token
- name: Generate CODEOWNERS file
run: go run ./scripts/generate-codeowners/...
14 changes: 14 additions & 0 deletions scripts/generate-codeowners/README
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Generate Codeowners

You will need a JSON file. This can be converted from a YAML or CSV formatted file.

To convert a CSV file into JSON format:
```
cat Grafana_TF_Provider_Ownership.csv | python -c 'import csv, json, sys; print(json.dumps([dict(r) for r in csv.DictReader(sys.stdin)]))' > grafana_tf_provider_ownership.json
```

## How to run

```
go run ./...
```
10 changes: 10 additions & 0 deletions scripts/generate-codeowners/go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
module github.com/grafanalabs/terraform-provider-grafana/scripts/generate-codeowners

go 1.24.2

require (
github.com/davecgh/go-spew v1.1.1 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
github.com/stretchr/testify v1.10.0 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
)
9 changes: 9 additions & 0 deletions scripts/generate-codeowners/go.sum
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
53 changes: 53 additions & 0 deletions scripts/generate-codeowners/main.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
package main

import (
"log"
"os"
"path/filepath"

"github.com/grafanalabs/terraform-provider-grafana/scripts/generate-codeowners/pkg/generator"
)

const (
generatedMarker = "# GENERATED BELOW (Regenerate with 'make CODEOWNERS')"
)

func main() {
repoRoot, err := filepath.Abs("../../")
if err != nil {
log.Fatalf("Failed to get absolute path: %v", err)
}

// Open the CODEOWNERS file for writing
codeownersFilePath := filepath.Join(repoRoot, ".github", "CODEOWNERS")
codeownersFile, err := os.OpenFile(codeownersFilePath, os.O_WRONLY, 0644)
if err != nil {
log.Fatalf("Failed to open CODEOWNERS file: %v", err)
}
defer func() {
if err := codeownersFile.Close(); err != nil {
log.Fatalf("Failed to close CODEOWNERS file: %v", err)
}
}()

pathsToCheck := []string{
"docs",
filepath.Join("internal", "resources"),
}

ownershipFilePath := filepath.Join(repoRoot, "ownership.json")
ownershipFile, err := os.OpenFile(ownershipFilePath, os.O_RDONLY, 0644)
if err != nil {
log.Fatalf("Failed to open ownership file: %v", err)
}
defer func() {
if err := ownershipFile.Close(); err != nil {
log.Fatalf("Failed to close ownership file: %v", err)
}
}()

generator := generator.New(repoRoot, codeownersFile, ownershipFile)
if err := generator.Generate(pathsToCheck); err != nil {
log.Fatal(err)
}
}
55 changes: 55 additions & 0 deletions scripts/generate-codeowners/pkg/generator/generator.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
package generator

import (
"encoding/json"
"io"
"io/fs"
"os"
)

type RepoRootFs interface {
fs.FS
Root() string
}

type RepoRootDirFs struct {
fs.FS
root string
}

func (r *RepoRootDirFs) Root() string {
return r.root
}

type Generator struct {
fs RepoRootFs
codeownersWriter io.Writer
ownershipReader io.Reader
}

func New(repoRoot string, codeownersFile io.Writer, ownershipFile io.Reader) *Generator {
return &Generator{
fs: &RepoRootDirFs{FS: os.DirFS(repoRoot), root: repoRoot},
codeownersWriter: codeownersFile,
ownershipReader: ownershipFile,
}
}

func (g *Generator) Generate(pathsToCheck []string) error {
g.readOwnershipFile()
return nil
}

func (g *Generator) readOwnershipFile() error {
ownershipFile, err := io.ReadAll(g.ownershipReader)
if err != nil {
return err
}

var ownership []map[string]interface{}
if err := json.Unmarshal(ownershipFile, &ownership); err != nil {
return err
}

return nil
}
37 changes: 37 additions & 0 deletions scripts/generate-codeowners/pkg/generator/generator_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
package generator_test

import (
"os"
"testing"

"github.com/grafanalabs/terraform-provider-grafana/scripts/generate-codeowners/pkg/generator"
"github.com/stretchr/testify/assert"
)

func TestGenerate(t *testing.T) {
tests := []struct {
name string
wantErr bool
repoRoot string
codeownersFile *os.File
pathsToCheck []string
ownershipFile *os.File
}{
{
name: "empty paths",
pathsToCheck: []string{},
wantErr: false,
repoRoot: ".",
codeownersFile: os.Stdout,
ownershipFile: os.Stdout,
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
generator := generator.New(tt.repoRoot, tt.codeownersFile, tt.ownershipFile)
err := generator.Generate(tt.pathsToCheck)
assert.NoError(t, err)
})
}
}
Loading