`MAINTAINER` to `LABEL` conversion does not escape embedded quotes

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

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

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

評価

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

調査の方向性

まず、MAINTAINER命令をLABEL値に書き換えるコードを見つけ、値内の引用符をどう処理するか確認します。報告に示されているDockerfileで問題を再現し、該当するformatterのテストを実行します。変換後の値で有効な引用符が保たれ、フォーマット後のDockerfileをビルドできるか、MAINTAINER行が変更されずに残れば完了です。

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

説明

Rewriting MAINTAINER into LABEL org.opencontainers.image.authors="..." wraps the value in double quotes without escaping the quotes it already contains.

Reproduce
FROM alpine
MAINTAINER Jane Doe "[email protected]"

dockerfmt Dockerfile
Actual
FROM alpine
LABEL org.opencontainers.image.authors="Jane Doe "[email protected]"

The quotes no longer pair up, and docker build fails on the output:

failed to process "\"Jane Doe \"[email protected]\"": unexpected end of statement while looking for matching double-quote
Expected

Escape embedded quotes:

LABEL org.opencontainers.image.authors="Jane Doe \"[email protected]\""

Leaving MAINTAINER unchanged when the value contains a quote would also work.

Impact

With --write the Dockerfile no longer builds. One of the three MAINTAINER lines in a sample of about 450 real-world Dockerfiles had quotes in its 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 を短くまとめたダイジェスト。