Legacy `ENV key value` with a multi-word value becomes an invalid `key=value`

クローズ 初心者向け
  • 何か問題がありますか？
#69 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

関連するプルリクエストがすでにマージされています。

  • #74 @RyoKusnadi による — マージ済み

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
84/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
docker, go
領域
devtools, tooling

調査の方向性

まず、dockerfmt が旧形式の ENV key value 命令をどのように解析して変換するかを追い、その後 ENV の処理に関するフォーマッターのテストを探します。提示された JAVA_OPTS の例で再現し、複数語の値を扱うテストを追加します。フォーマットによって、ビルドでき、再度フォーマットできる有効な Dockerfile 構文が生成されれば完了です。

索引モデルが issue の本文から書いたものです。

説明

Converting a legacy ENV key value instruction to the key=value form breaks when the value contains spaces. The output is not a valid Dockerfile: docker build rejects it, and so does dockerfmt on the next run.

Reproduce
FROM alpine
ENV JAVA_OPTS -Xms256m -Xmx512m

dockerfmt Dockerfile
Actual
FROM alpine
ENV JAVA_OPTS=-Xms256m -Xmx512m

The original builds and sets JAVA_OPTS=-Xms256m -Xmx512m. docker build on the output, and dockerfmt run on it again, both fail with:

Error parsing file: Syntax error - can't find = in "-Xmx512m". Must be of the form: name=value
Expected

In the legacy form everything after the key is the value, so the converted instruction needs quotes:

ENV JAVA_OPTS="-Xms256m -Xmx512m"

Leaving the instruction in its legacy form would also be correct.

Impact

With --write the Dockerfile no longer builds. In a sample of about 450 real-world Dockerfiles, 112 lines used the legacy ENV form and one of them had an unquoted multi-word value.

Reproduced with v0.5.4 and with main at a5868c2.

主要言語
Go
スター
626
フォーク
23
平均マージ
3日 17時間
マージ済み PR（30日）
9

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

似ている issue

Go の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。