atlasaction: update schema lint format (#226)

* atlasaction: update schema lint format * chore: fixed typo
ariga · Sep 18, 2024 · 1449122 · 1449122
1 parent 16c70fd
commit 1449122
Show file tree

Hide file tree

Showing 11 changed files with 93 additions and 80 deletions.
diff --git a/.github/workflows/ci-go.yaml b/.github/workflows/ci-go.yaml
@@ -65,6 +65,8 @@ jobs:
  runs-on: ubuntu-latest
  steps:
  - uses: ariga/setup-atlas@v0
+ with:
+ cloud-token: ${{ secrets.ATLAS_TOKEN }}
  - uses: actions/checkout@v3
  - uses: actions/setup-go@v4
  with:

diff --git a/atlasaction/action.go b/atlasaction/action.go
@@ -604,7 +604,11 @@ func (a *Actions) SchemaPlan(ctx context.Context) error {
  a.SetOutput("plan", plan.File.URL)
  a.SetOutput("status", plan.File.Status)
  // Report the schema plan to the user and add a comment to the PR.
- summary, err := schemaPlanComment(plan, params.Env, tc.RerunCmd)
+ summary, err := RenderTemplate("schema-plan.tmpl", map[string]any{
+ "Plan": plan,
+ "EnvName": params.Env,
+ "RerunCommand": tc.RerunCmd,
+ })
  if err != nil {
  return fmt.Errorf("failed to generate schema plan comment: %w", err)
  }
@@ -925,19 +929,6 @@ func (a *Actions) addSuggestions(lint *atlasexec.SummaryReport, fn func(*Suggest
  return nil
 }
 
-func schemaPlanComment(payload *atlasexec.SchemaPlan, envName, rerun string) (string, error) {
- data := map[string]any{
- "Plan": payload,
- "EnvName": envName,
- "RerunCommand": rerun,
- }
- var buf bytes.Buffer
- if err := commentsTmpl.ExecuteTemplate(&buf, "schema-plan.tmpl", data); err != nil {
- return "", err
- }
- return buf.String(), nil
-}
-
 func execTime(start, end time.Time) string {
  return end.Sub(start).String()
 }

diff --git a/atlasaction/action_test.go b/atlasaction/action_test.go
diff --git a/atlasaction/comments/lint-report.tmpl b/atlasaction/comments/lint-report.tmpl
@@ -1,37 +1,4 @@
 {{- define "lint-report" -}}
-<table>
- <thead>
- <tr>
- <th>Status</th>
- <th>Step</th>
- <th>Result</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- {{- block "lint-first-step" . -}}
- {{- template "lint-check" "success.svg" -}}
- <td>
- {{- $fileCount := len .Files -}}
- {{- if eq $fileCount 1 -}}
- 1 new migration file detected
- {{- else if $fileCount -}}
- {{- $fileCount }} new migration files detected
- {{- else -}}
- No migration files detected
- {{- end -}}
- </td>
- <td>
- {{- with .Files -}}
- {{- range $i, $f := . -}}
- {{- if $i -}}<br/>{{- end -}}{{- $f.Name -}}
- {{- end -}}
- {{- else -}}
- &nbsp;
- {{- end -}}
- </td>
- {{- end -}}
- </tr>
 {{- with .URL -}}
  <tr>
  {{- template "lint-check" "success.svg" -}}
@@ -74,8 +41,6 @@
 {{- with .URL -}}
  <tr><td colspan="4"><div align="center">Read the full linting report on {{ . | link "Atlas Cloud" -}}</div></td></tr>
 {{- end -}}
- </tbody>
-</table>
 {{- end -}}
 {{- define "lint-check" -}}
 <td><div align="center">{{- assetsImage . | image "20px" -}}</div></td>

diff --git a/atlasaction/comments/migrate-lint.tmpl b/atlasaction/comments/migrate-lint.tmpl
@@ -1,2 +1,33 @@
-<code>atlas migrate lint</code> on <strong>{{- .Env.Dir }}</strong>
+<code>atlas migrate lint</code> on <strong>{{- .Env.Dir }}</strong><table>
+ <thead>
+ <tr>
+ <th>Status</th>
+ <th>Step</th>
+ <th>Result</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+{{- template "lint-check" "success.svg" -}}
+ <td>
+ {{- $fileCount := len .Files -}}
+ {{- if eq $fileCount 1 -}}
+ 1 new migration file detected
+ {{- else if $fileCount -}}
+ {{- $fileCount }} new migration files detected
+ {{- else -}}
+ No migration files detected
+ {{- end -}}
+ </td>
+ <td>
+ {{- with .Files -}}
+ {{- range $i, $f := . -}}
+ {{- if $i -}}<br/>{{- end -}}{{- $f.Name -}}
+ {{- end -}}
+ {{- else -}}
+ &nbsp;
+ {{- end -}}
+ </td>
+ </tr>
 {{- template "lint-report" . -}}
+ </body></table>
diff --git a/atlasaction/comments/schema-apply.tmpl b/atlasaction/comments/schema-apply.tmpl
@@ -52,7 +52,7 @@
  {{- .File.Migration | codeblock "sql" | details (printf "📄 View %s Statements" $kind) -}}
  {{- with .Lint -}}
 <h4>Atlas lint results</h4>
- {{- template "lint-report" . -}}
+ {{- template "schema-lint" $ -}}
  {{- end -}}
 {{/* Fallback to the old output */}}
 {{- else with .Changes -}}

diff --git a/atlasaction/comments/schema-plan.tmpl b/atlasaction/comments/schema-plan.tmpl
@@ -2,7 +2,7 @@
 <h4>SQL Plan</h4>
 {{- .Plan.File.Migration | codeblock "sql" -}}
 <h4>Atlas lint results</h4>
-{{- template "lint-report" .Plan.Lint -}}
+{{- template "schema-lint" . -}}
 <hr>
 <details>
  <summary>📝 To edit this plan, follow these steps</summary>
@@ -14,4 +14,32 @@
  <li>Re-trigger this action using <code>{{ .RerunCommand }}</code></li>
  {{- end -}}
  </ol>
-</details>
+</details>
+{{- define "schema-lint" -}}
+<table>
+ <thead>
+ <tr>
+ <th>Status</th>
+ <th>Step</th>
+ <th>Result</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ {{- template "lint-check" "success.svg" -}}
+ {{- with .Plan.File -}}
+ <td>Detect schema changes</td><td>
+ {{- $stmtCount := len .Stmts -}}
+ {{- if eq $stmtCount 1 -}}
+ 1 new statement detected
+ {{- else if $stmtCount -}}
+ {{- $stmtCount }} new statements detected
+ {{- else -}}
+ No statements detected
+ {{- end -}}
+ </td>
+ </tr>
+ {{- end -}}
+ {{- template "lint-report" .Plan.Lint -}}
+ </tbody></table>
+{{- end -}}
diff --git a/atlasaction/testdata/github/schema-apply-envs.txtar b/atlasaction/testdata/github/schema-apply-envs.txtar
@@ -21,9 +21,9 @@ Abort: The plan "From" hash does not match the current state hash (passed with -
  + R1cGcSfo1oWYK4dz+7WvgCtE/QppFo9lKFEqEDzoS4o= (current hash)
 
 -- schema-apply/1/stdout --
-{"Driver":"sqlite3","URL":{"Scheme":"sqlite","Opaque":"","User":null,"Host":"local-bu.db","Path":"","RawPath":"","OmitHost":false,"ForceQuery":false,"RawQuery":"","Fragment":"","RawFragment":"","Schema":"main"},"Start":"2024-09-12T21:31:20.339663+07:00","End":"2024-09-12T21:31:20.351603+07:00","Applied":{"Name":"20240910173744.sql","Version":"20240910173744","Start":"2024-09-12T21:31:20.350607+07:00","End":"2024-09-12T21:31:20.351228+07:00","Applied":["ALTER TABLE `t4` ADD COLUMN `c2` integer NOT NULL;"]},"Plan":{"Env":{"Driver":"sqlite3","URL":{"Scheme":"sqlite","Opaque":"","User":null,"Host":"local-bu.db","Path":"","RawPath":"","OmitHost":false,"ForceQuery":false,"RawQuery":"","Fragment":"","RawFragment":"","Schema":"main"}},"File":{"Name":"20240910173744","FromHash":"iHZMQ1EoarAXt/KU0KQbBljbbGs8gVqX2ZBXefePSGE=","ToHash":"Cp8xCVYilZuwULkggsfJLqIQHaxYcg/IpU+kgjVUBA4=","Migration":"-- Add column \"c2\" to table: \"t4\"\nALTER TABLE `t4` ADD COLUMN `c2` integer NOT NULL;\n","URL":"file://20240910173744.plan.hcl"}},"Changes":{"Applied":["ALTER TABLE `t4` ADD COLUMN `c2` integer NOT NULL;"]}}
-{"Driver":"sqlite3","URL":{"Scheme":"sqlite","Opaque":"","User":null,"Host":"local-pi.db","Path":"","RawPath":"","OmitHost":false,"ForceQuery":false,"RawQuery":"","Fragment":"","RawFragment":"","Schema":"main"},"Start":"2024-09-12T21:31:20.354074+07:00","End":"2024-09-12T21:31:20.35764+07:00","Applied":{"Name":"20240910173744.sql","Version":"20240910173744","Start":"2024-09-12T21:31:20.356221+07:00","End":"2024-09-12T21:31:20.356755+07:00","Applied":["ALTER TABLE `t4` ADD COLUMN `c2` integer NOT NULL;"]},"Plan":{"Env":{"Driver":"sqlite3","URL":{"Scheme":"sqlite","Opaque":"","User":null,"Host":"local-pi.db","Path":"","RawPath":"","OmitHost":false,"ForceQuery":false,"RawQuery":"","Fragment":"","RawFragment":"","Schema":"main"}},"File":{"Name":"20240910173744","FromHash":"iHZMQ1EoarAXt/KU0KQbBljbbGs8gVqX2ZBXefePSGE=","ToHash":"Cp8xCVYilZuwULkggsfJLqIQHaxYcg/IpU+kgjVUBA4=","Migration":"-- Add column \"c2\" to table: \"t4\"\nALTER TABLE `t4` ADD COLUMN `c2` integer NOT NULL;\n","URL":"file://20240910173744.plan.hcl"}},"Changes":{"Applied":["ALTER TABLE `t4` ADD COLUMN `c2` integer NOT NULL;"]}}
-{"Driver":"sqlite3","URL":{"Scheme":"sqlite","Opaque":"","User":null,"Host":"local-su.db","Path":"","RawPath":"","OmitHost":false,"ForceQuery":false,"RawQuery":"","Fragment":"","RawFragment":"","Schema":"main"},"Start":"2024-09-12T21:31:20.360863+07:00","End":"2024-09-12T21:31:20.368395+07:00","Applied":{"Name":"20240910173744.sql","Version":"20240910173744","Start":"2024-09-12T21:31:20.364331+07:00","End":"2024-09-12T21:31:20.365086+07:00","Applied":["ALTER TABLE `t4` ADD COLUMN `c2` integer NOT NULL;"]},"Plan":{"Env":{"Driver":"sqlite3","URL":{"Scheme":"sqlite","Opaque":"","User":null,"Host":"local-su.db","Path":"","RawPath":"","OmitHost":false,"ForceQuery":false,"RawQuery":"","Fragment":"","RawFragment":"","Schema":"main"}},"File":{"Name":"20240910173744","FromHash":"iHZMQ1EoarAXt/KU0KQbBljbbGs8gVqX2ZBXefePSGE=","ToHash":"Cp8xCVYilZuwULkggsfJLqIQHaxYcg/IpU+kgjVUBA4=","Migration":"-- Add column \"c2\" to table: \"t4\"\nALTER TABLE `t4` ADD COLUMN `c2` integer NOT NULL;\n","URL":"file://20240910173744.plan.hcl"}},"Changes":{"Applied":["ALTER TABLE `t4` ADD COLUMN `c2` integer NOT NULL;"]}}
+{"Driver":"sqlite3","URL":{"Scheme":"sqlite","Opaque":"","User":null,"Host":"local-bu.db","Path":"","RawPath":"","OmitHost":false,"ForceQuery":false,"RawQuery":"","Fragment":"","RawFragment":"","Schema":"main"},"Start":"2024-09-18T11:19:23.232253+07:00","End":"2024-09-18T11:19:23.238022+07:00","Applied":{"Name":"20240910173744.sql","Version":"20240910173744","Start":"2024-09-18T11:19:23.237559+07:00","End":"2024-09-18T11:19:23.237793+07:00","Applied":["ALTER TABLE `t4` ADD COLUMN `c2` integer NOT NULL;"]},"Plan":{"Env":{"Driver":"sqlite3","URL":{"Scheme":"sqlite","Opaque":"","User":null,"Host":"local-bu.db","Path":"","RawPath":"","OmitHost":false,"ForceQuery":false,"RawQuery":"","Fragment":"","RawFragment":"","Schema":"main"}},"File":{"Name":"20240910173744","FromHash":"iHZMQ1EoarAXt/KU0KQbBljbbGs8gVqX2ZBXefePSGE=","ToHash":"Cp8xCVYilZuwULkggsfJLqIQHaxYcg/IpU+kgjVUBA4=","Migration":"-- Add column \"c2\" to table: \"t4\"\nALTER TABLE `t4` ADD COLUMN `c2` integer NOT NULL;\n","Stmts":[{"Pos":34,"Text":"ALTER TABLE `t4` ADD COLUMN `c2` integer NOT NULL;","Comments":["-- Add column \"c2\" to table: \"t4\"\n"]}],"URL":"file://20240910173744.plan.hcl"}},"Changes":{"Applied":["ALTER TABLE `t4` ADD COLUMN `c2` integer NOT NULL;"]}}
+{"Driver":"sqlite3","URL":{"Scheme":"sqlite","Opaque":"","User":null,"Host":"local-pi.db","Path":"","RawPath":"","OmitHost":false,"ForceQuery":false,"RawQuery":"","Fragment":"","RawFragment":"","Schema":"main"},"Start":"2024-09-18T11:19:23.239729+07:00","End":"2024-09-18T11:19:23.242458+07:00","Applied":{"Name":"20240910173744.sql","Version":"20240910173744","Start":"2024-09-18T11:19:23.241765+07:00","End":"2024-09-18T11:19:23.24208+07:00","Applied":["ALTER TABLE `t4` ADD COLUMN `c2` integer NOT NULL;"]},"Plan":{"Env":{"Driver":"sqlite3","URL":{"Scheme":"sqlite","Opaque":"","User":null,"Host":"local-pi.db","Path":"","RawPath":"","OmitHost":false,"ForceQuery":false,"RawQuery":"","Fragment":"","RawFragment":"","Schema":"main"}},"File":{"Name":"20240910173744","FromHash":"iHZMQ1EoarAXt/KU0KQbBljbbGs8gVqX2ZBXefePSGE=","ToHash":"Cp8xCVYilZuwULkggsfJLqIQHaxYcg/IpU+kgjVUBA4=","Migration":"-- Add column \"c2\" to table: \"t4\"\nALTER TABLE `t4` ADD COLUMN `c2` integer NOT NULL;\n","Stmts":[{"Pos":34,"Text":"ALTER TABLE `t4` ADD COLUMN `c2` integer NOT NULL;","Comments":["-- Add column \"c2\" to table: \"t4\"\n"]}],"URL":"file://20240910173744.plan.hcl"}},"Changes":{"Applied":["ALTER TABLE `t4` ADD COLUMN `c2` integer NOT NULL;"]}}
+{"Driver":"sqlite3","URL":{"Scheme":"sqlite","Opaque":"","User":null,"Host":"local-su.db","Path":"","RawPath":"","OmitHost":false,"ForceQuery":false,"RawQuery":"","Fragment":"","RawFragment":"","Schema":"main"},"Start":"2024-09-18T11:19:23.244225+07:00","End":"2024-09-18T11:19:23.247165+07:00","Applied":{"Name":"20240910173744.sql","Version":"20240910173744","Start":"2024-09-18T11:19:23.246708+07:00","End":"2024-09-18T11:19:23.246929+07:00","Applied":["ALTER TABLE `t4` ADD COLUMN `c2` integer NOT NULL;"]},"Plan":{"Env":{"Driver":"sqlite3","URL":{"Scheme":"sqlite","Opaque":"","User":null,"Host":"local-su.db","Path":"","RawPath":"","OmitHost":false,"ForceQuery":false,"RawQuery":"","Fragment":"","RawFragment":"","Schema":"main"}},"File":{"Name":"20240910173744","FromHash":"iHZMQ1EoarAXt/KU0KQbBljbbGs8gVqX2ZBXefePSGE=","ToHash":"Cp8xCVYilZuwULkggsfJLqIQHaxYcg/IpU+kgjVUBA4=","Migration":"-- Add column \"c2\" to table: \"t4\"\nALTER TABLE `t4` ADD COLUMN `c2` integer NOT NULL;\n","Stmts":[{"Pos":34,"Text":"ALTER TABLE `t4` ADD COLUMN `c2` integer NOT NULL;","Comments":["-- Add column \"c2\" to table: \"t4\"\n"]}],"URL":"file://20240910173744.plan.hcl"}},"Changes":{"Applied":["ALTER TABLE `t4` ADD COLUMN `c2` integer NOT NULL;"]}}
 -- output.txt --
 error<<_GitHubActionsFileCommandDelimeter_
 Abort: The plan "From" hash does not match the current state hash (passed with --from): - iHZMQ1EoarAXt/KU0KQbBljbbGs8gVqX2ZBXefePSGE= (plan value) + R1cGcSfo1oWYK4dz+7WvgCtE/QppFo9lKFEqEDzoS4o= (current hash)
@@ -49,7 +49,7 @@ _GitHubActionsFileCommandDelimeter_
  <td><code>file://20240910173744.plan.hcl</code></td>
  </tr><tr>
  <td>Total Time</td>
- <td>11.94ms</td>
+ <td>5.769ms</td>
  </tr></table><h4>Version 20240910173744.sql:</h4>
 <table>
  <tr>
@@ -60,7 +60,7 @@ _GitHubActionsFileCommandDelimeter_
  <th>Error Statement</th>
  </tr>
  <tr><td><div align="center"><picture><source media="(prefers-color-scheme: light)" srcset="https://release.ariga.io/images/assets/success.svg?v=1"><img width="20px" height="20px" src="https://release.ariga.io/images/assets/success.svg?v=1"/></picture></div></td><td>1</td>
- <td>621µs</td><td>-</td><td>-</td></tr>
+ <td>234µs</td><td>-</td><td>-</td></tr>
 </table><details><summary>📄 View Pre-planned SQL Statements</summary><pre lang="sql"><code>-- Add column "c2" to table: "t4"
 ALTER TABLE `t4` ADD COLUMN `c2` integer NOT NULL;
 </code></pre></details>
@@ -84,7 +84,7 @@ ALTER TABLE `t4` ADD COLUMN `c2` integer NOT NULL;
  <td><code>file://20240910173744.plan.hcl</code></td>
  </tr><tr>
  <td>Total Time</td>
- <td>3.566ms</td>
+ <td>2.729ms</td>
  </tr></table><h4>Version 20240910173744.sql:</h4>
 <table>
  <tr>
@@ -95,7 +95,7 @@ ALTER TABLE `t4` ADD COLUMN `c2` integer NOT NULL;
  <th>Error Statement</th>
  </tr>
  <tr><td><div align="center"><picture><source media="(prefers-color-scheme: light)" srcset="https://release.ariga.io/images/assets/success.svg?v=1"><img width="20px" height="20px" src="https://release.ariga.io/images/assets/success.svg?v=1"/></picture></div></td><td>1</td>
- <td>534µs</td><td>-</td><td>-</td></tr>
+ <td>315µs</td><td>-</td><td>-</td></tr>
 </table><details><summary>📄 View Pre-planned SQL Statements</summary><pre lang="sql"><code>-- Add column "c2" to table: "t4"
 ALTER TABLE `t4` ADD COLUMN `c2` integer NOT NULL;
 </code></pre></details>
@@ -119,7 +119,7 @@ ALTER TABLE `t4` ADD COLUMN `c2` integer NOT NULL;
  <td><code>file://20240910173744.plan.hcl</code></td>
  </tr><tr>
  <td>Total Time</td>
- <td>7.532ms</td>
+ <td>2.94ms</td>
  </tr></table><h4>Version 20240910173744.sql:</h4>
 <table>
  <tr>
@@ -130,7 +130,7 @@ ALTER TABLE `t4` ADD COLUMN `c2` integer NOT NULL;
  <th>Error Statement</th>
  </tr>
  <tr><td><div align="center"><picture><source media="(prefers-color-scheme: light)" srcset="https://release.ariga.io/images/assets/success.svg?v=1"><img width="20px" height="20px" src="https://release.ariga.io/images/assets/success.svg?v=1"/></picture></div></td><td>1</td>
- <td>755µs</td><td>-</td><td>-</td></tr>
+ <td>221µs</td><td>-</td><td>-</td></tr>
 </table><details><summary>📄 View Pre-planned SQL Statements</summary><pre lang="sql"><code>-- Add column "c2" to table: "t4"
 ALTER TABLE `t4` ADD COLUMN `c2` integer NOT NULL;
 </code></pre></details>