Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#3 shellcheck(静的解析)と shfmt(lint)の実装 #13

Merged
merged 20 commits into from
May 27, 2021

Conversation

KEINOS
Copy link
Member

@KEINOS KEINOS commented May 25, 2021

Issue #3 の実装です。

とりあえず、このドラフト PR で以下を実装します 。

実装(?)してみました。Merge されないと GitHub Actions の動画確認できないっぽい ... Fork 先でも何かできませんでした。

すること

  • 再現・開発用の Dockerfile (現在 Alpine Linux)
  • shellcheck および shfmt の実行スクリプト(./.github/run-lint.sh
  • 初回 shellceck および shfmt の修正
  • GitHub Action による shellceck および shfmt のテスト

しないこと

  • 静的解析と lint の修正を除く既存スクリプトのリファクタリング(関数化など)
  • 各スクリプトファイルにある関数の単体テスト
  • 新たな機能追加

@KEINOS KEINOS self-assigned this May 25, 2021
@KEINOS
Copy link
Member Author

KEINOS commented May 26, 2021

lint と静的解析の修正とは言え、やはり、これだけのファイルの修正があると単体テストがホスィ ...
動作テストも面倒なので怖い
テスト書きたくなるけど、でもそれは別 PR ... 我慢 ... 我慢 ...

@KEINOS KEINOS requested a review from yoshi389111 May 26, 2021 12:58
@KEINOS
Copy link
Member Author

KEINOS commented May 26, 2021

とりえあず、現状の状態のレビューお願いします m(_ _)m

@yoshi389111
Copy link
Collaborator

yoshi389111 commented May 26, 2021

試しに GitHubActions を動かしてみたところ(自分のところの master あてにPRを送った。マージはしていない)、以下のようなエラーが出ました。

image

取り急ぎ、ご報告まで


【追記 2021-05-26 23:56】

go mod download を削除して実行したところ、正常に実行できているようにみえます。

image

@KEINOS
Copy link
Member Author

KEINOS commented May 26, 2021

やはり、どこかにマージしないと動かせないのかしら。gh とか act も一旦マージされないとローカルで実行できなさそうでした。

go mod download を削除

あー!!!go.mod なんてないから、そら動かないですよね!

@KEINOS
Copy link
Member Author

KEINOS commented May 26, 2021

@yoshi389111

削除してみました。お手数ですがお手すきに確認お願いします。

大丈夫そうだったら Squash & Merge して、テストの作成に入りたいと思います。

@KEINOS KEINOS marked this pull request as ready for review May 27, 2021 00:40
@yoshi389111
Copy link
Collaborator

yoshi389111 commented May 27, 2021

確認してみました。前回のエラーは出ていません(正常に終了しています)が、気になる点が何点か

適当にシェルを修正して2回目のpushをすると、キャッシュが効いていないように思います。

  • actions/cache@v2 の step に id が付いていないから?
  • id をつけると2回目の実行でエラー(shfmtがインストールされていない)。とりあえずキャッシュ対象を ~/go にすると動くようです。

archive を shellcheck に引っ掛かるような修正をしてpushしましたが、エラーになっていません。
run-lint.sh がうまく動いていないようです。

  • shellcheckのループ while [ ! "${1:+none}" ]; dowhile [ -n "${1:+none}" ]; do に修正
  • shfmt のループ while [ ! "$1" ]; dowhile [ -n "${1:+none}" ]; do に修正
  • shellcheck で失敗しても result が設定されていないようです。shfmtと同じように result を定義/設定/返却するとOK

また、以下でエラーが出ています

  • check コマンドが shfmt に引っ掛かる(余計なスペースが入っているとのこと)

クォータの容量に問題が起きたら考えることにする。
@KEINOS
Copy link
Member Author

KEINOS commented May 27, 2021

2回目のpushをすると、キャッシュが効いていない

ご確認ありがとうございます!ご指摘の通り、キャッシュが効いてもビルドされたバイナリがキャッシュに含まれていないことが原因でした。

コミット 597a646 でキャッシュを消しました。キャッシュが必要なくらいの重さであったら再考したいと思います。

archive を shellcheck に引っ掛かるような修正をしてpushしましたが、エラーになっていません。

false positive が出ていることを確認しました。今日の夕方に修正いたします。

@KEINOS
Copy link
Member Author

KEINOS commented May 27, 2021

@yoshi389111

正常が異常なのだ問題の修正と、shfmt のエラーを修正しました!
お手すきにチェックお願いします。

Copy link
Collaborator

@yoshi389111 yoshi389111 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

確認しました。問題ないと思います

LGTM


[*.{yml,yaml,json}]
indent_style = space
indent_size = 4
Copy link
Collaborator

@yoshi389111 yoshi389111 May 26, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

少しだけ気になったのは、ワークフローの定義 .github/workflows/shellcheck_linux.yml は、インデントがスペース2個になっています。

(jsonファイルはインデント 4 になっているようなので)
yml,yamlを分離して 2 にするか、あるいは shellcheck_linux.yml のインデントをスペース4個にすべきではないでしょうか?

修正はあとでもよい気がしますが

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

確かに .editorconfig で定義しているのにそう・・でないのは気持ち悪いですね。気づきませんでした。さすがです。

分離して、ポカよけでフォーマッタを入れてみました。

@KEINOS KEINOS merged commit 2b5604b into Qithub-BOT:master May 27, 2021
@KEINOS KEINOS deleted the KEINOS-static-analysis-and-lint branch May 27, 2021 11:04
This was referenced May 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants