CS 版と VB 版の設定ファイルの同期方針を決める

[OsscJpDevInfra]

概要

CS 版と VB 版の設定ファイルが、どこまで同じで、どこから違うのかが決まっていない。

Samples/WebApp_sample の Web.config は CS / VB でほぼ同じ内容だが、完全には同じでない。
「同じはずだから」とコピーすると、VB 固有の記述が消える。 実際に消した（後述）。

同期の方針を決め、差分が意図的なものだけになる状態にしたい。

現状

実際に起きたこと

#549 の作業で、CS 側 Web.config のコメントを整理した。同じコメントを VB 側にも入れるため
CS のファイルをコピーしたところ、VB 固有の内容が失われた。

ファイル	失われたもの
VB/Samples/WebApp_sample/MVC_Sample/MVC_Sample/Web.config	system.web/compilation/assemblies とその add（System.Runtime ほか）2 要素
VB/Samples/WebApp_sample/WebForms_Sample/WebForms_Sample/web.config	接続文字列 ConnectionString_MCN の末尾の ; の有無が CS 側の値に変わった

0_RunAll.ps1 -Lang Both は通った。 ビルドも疎通も問題なかったため、
気付かずにコミットされ得る状態だった（要素の突き合わせで検出した）。

VB 側は HEAD に戻してある。

ファイル名すら揃っていない

	CS	VB
MVC	Web.config	Web.config
Web Forms	Web.config	web.config（小文字）

Windows では区別されないため今まで問題になっていないが、#550 と同じ種類の落とし穴である。

「同一性の実測」は Samples4NetCore にしかない

Samples4NetCore/ANALYSIS.md 4-1 節には、
Samples（net48）との同一ファイル数・差異ファイル数が実測で載っている。

CS / VB 間には、これに相当する記録が無い。
#542（VB の疎通確認）で「疎通の手順はそのまま通る」ことは確かめたが、
設定ファイルの中身までは突き合わせていない。

対応（案）

① まず突き合わせる

CS / VB の対応する設定ファイル（Web.config / app.config / appsettings.json）を
機械的に比較し、差分を「意図的」と「事故」に仕分ける。

比較は XML の要素・属性で行う（コメントや空白の差は無視する）。
#549 の作業では、この方法で 2 要素の欠落と 1 属性の変化を検出できた。

要素・属性が HEAD と一致 : False
  - 失われた : /configuration/system.web/compilation/assemblies
  + 増えた   : ... connectionString='...Password=seigi@123;' ...

② 意図的な差分を記録する

「CS / VB で違ってよい箇所」を文書に残す。 置き場所は
CONFIGURATION.md（設定の仕組みは既にここに集約した）か、
各 ANALYSIS.md の対応表。

③ 事故を直す

意図しない差分を揃える。

④ 再発を防ぐ

丸ごとコピーしない、という運用にする。今回は
「アンカー 1 行の直後にコメント ブロックだけを挿入する」形に直した。

さらに、差分の行数を必ず見る。今回は
「16 行足したはずが +23/−53 になっている」ことで気付いた。

自動チェックまで作るかは要検討。
2_RunAllTests.ps1 のような「期待値との突き合わせ」に載せる手はあるが、
意図的な差分を許容リストで持つ必要があるので、①②を済ませてからが良い。

影響

• 利用者への影響: 無し（設定値を揃える場合を除く。揃えるなら、その時点で改めて判断する）
• net48 / net10.0: 主に net48（Samples の Web.config / app.config）。
  Samples4NetCore には VB 版が無いため対象外
• 検証: 0_RunAll.ps1 -Lang Both

補足

この Issue は「揃える」ことが目的ではない。
違ってよい所は違ってよく、それが記録されていないことが問題である。
記録が無いと、今回のように「同じはずだ」と考えてコピーしてしまう。

関連: #542（VB の疎通確認）、#549（この問題が表面化した作業）、
#550（大文字小文字。ファイル名の web.config / Web.config は同種）

[OsscJpDevInfra]

①②を済ませ、③は 3 件だけ適用しました

進め方を変えた

当初は「CS を VB へコピー → 差分を見る → 影響があれば戻す → CI」を考えていたが、
測ってみると、この順では危ないと分かったので変えた。

(1) CS → 作業用の場所へコピー（リポジトリは触らない）
(2) 値の差を検出
(3) **意図した差分だけ**をリポジトリへ適用
(4) CI

リポジトリに一度も「壊れた状態」を入れないので、(3) で戻す作業そのものが要らなくなる。

なぜ変えたか — CI はこの種の変更をほとんど検出できない

差分のあるファイル	16 組
うち VB の疎通テストで一度も実行されない	9 組（2CS_sample / WS_sample / GenDaoAndBatUpd / Frameworks）

VB の疎通対象は 6 つ（SimpleBatch / RerunnableBatch×3 / MVC_Sample / WebForms_Sample）しかない。

実行される分でも検出できない。VB/MVC_Sample/Web.config から
compilation/assemblies が消えた状態で 0_RunAll.ps1 -Lang Both は通った（実測）。

CI は「壊れていないこと」の証拠にはなるが、「意図どおり」の証拠にはならない。

① 突き合わせ（実測）

対応する設定ファイル 25 組を、XML の要素・属性で比較した
（コメント・空白・改行・BOM の差は無視）。

	組数
同一（順序のみの相違を含む）	9
差分あり	16

差分の種類	組数	判断
startup / supportedRuntime（VB のみ）	10	違ってよい（VS が VB プロジェクトに自動で入れる）
runtime/assemblyBinding の bindingRedirect	8	違ってよい（NuGet の生成物）
packages.config の構成	2	触らない（CS だけが Microsoft.AspNet.WebApi / FriendlyUrls を持つ）
ClientSettingsProvider.ServiceUri（VB のみ）	1	違ってよい（VS のテンプレート由来）
SqlTextFilePath の値	1	違わないといけない（下記）
compilation/assemblies（VB のみ）	1	違ってよい
接続文字列の末尾の ;	1	揃えた（③）
要素の順序だけ	1	無視してよい

一番の収穫 — 同じにすると壊れる差分があった

Samples/2CS_sample/GenDaoAndBatUpd_sample/app.config

CS : <add key="SqlTextFilePath" value="GenDaoAndBatUpd_sample.Dao" />
VB : <add key="SqlTextFilePath" value="GenDaoAndBatUpd_sample" />

埋め込みリソースのマニフェスト名の作られ方が、言語で違う。

	マニフェスト名
C#	＜RootNamespace＞.＜フォルダ＞.＜ファイル名＞
VB	＜RootNamespace＞.＜ファイル名＞（フォルダ名が入らない）

RootNamespace はどちらも GenDaoAndBatUpd_sample、EmbeddedResource Include="Dao\..." も同じ。
違うのはコンパイラの規則なので、設定値で吸収するしかない。

「揃えればよい」という前提が成り立たない実例。 この Issue の核心はここだと思う。

② 記録した場所

CONFIGURATION.md に **11 節「CS 版と VB 版で、どこが違ってよいか」**を新設した。

• 突き合わせの結果（上の 2 表）
• 違わないといけないもの（埋め込みリソース名）を理由つきで
• 揃えるときの原則（丸ごとコピーしない / 差分の行数を必ず見る / 要素・属性で機械的に検証）

既存の節番号は変えていないので、各設定ファイルからの「8 節」「9 節」等の参照はそのまま有効。

④ 再発防止 — CompareConfig.ps1 を追加した

root/programs/CompareConfig.ps1（新規）

.\CompareConfig.ps1                                # 一覧
.\CompareConfig.ps1 -Detail -Only "WebApp_sample"   # 内訳

• XML の要素・属性だけを取り出して比較する。 素の diff ではコメントや空白に
  埋もれて見えない値の差だけが残る
• git ls-files ベース。 ビルド出力（Build\*.dll.config）や packages\ を拾わない
• PowerShell 5.1 / 7 の両方で構文確認済み。SummaryTable.ps1 を利用（全角の桁ずれ対策）
• 終了コードは常に 0。差分があること自体は異常ではないため、合否ではなく一覧として使う

Python ではなく PowerShell にしたのは、リポジトリに .py が 1 件も無く、
CompareResult.ps1 という比較スクリプトの前例があるため。

③ 適用したもの（3 件だけ）

ファイル	内容	差分
VB/…/MVC_Sample/Web.config	CONFIGURATION.md への誘導コメント	+15 / −0
VB/…/WebForms_Sample/web.config	同上（ViewState の一文を含む）	+17 / −1
〃	ConnectionString_MCN の末尾に ;（CS に合わせた）	上に含む

HEAD の内容を土台にして差し込む方式にしたので、既存記述の欠落が構造的に起こらない。

検査	結果
XML 妥当性	OK
要素・属性の増減	MVC ±0 / WebForms +1 / −1（意図した ; のみ）
BOM・改行	HEAD どおり、単独 LF なし
CompareConfig.ps1	WebForms_Sample/Web.config が 差分 → 同一（順序のみ）

検証

	結果
0_RunAll.ps1 -Lang VB	全対象 OK / ExitCode=0（ビルド 0、疎通 6/6）
2_RunAllTests.ps1	8-8、差分 0、全テスト OK

変更が実行時に効くのは VB の 2 ファイルだけなので、-Lang VB を選んだ。
VB の疎通は MVC_Sample と WebForms_Sample を実際に起動するため、
変更した 2 ファイルは両方とも読まれている。

-Lang Both を一度回したが、3_SmokeTest.ps1 の途中で中断した。
そこまでで 1_BuildAll.ps1 は既知の MSB3482（ClickOnce 署名）1 件のみ、
2_RunAllTests.ps1 は 8-8 差分 0 だった。

0_RunAll.ps1 には -IgnoreErrors を渡す口が無いため、-Lang Both で回すと
この既知エラーが必ず NG として計上される。判定時は中身を見る必要がある。
気になるなら、既定の除外を持たせるのは別途。

残していること

• packages.config の差（CS だけが Microsoft.AspNet.WebApi / FriendlyUrls を持つ）。
  機能差なら意図的、参照漏れなら事故。判断が付かないので触っていない
• Newtonsoft.Json の bindingRedirect（WSClientWin2_sample で CS=13.0.0.0 / VB=11.0.0.0）。
  生成物なので、直すならパッケージ側。
  Frameworks/ANALYSIS.md の
  「依存パッケージのバージョン ドリフト」と同じ扱いが妥当と考える
• 自動チェック（CI への組み込み）は行っていない。
  CompareConfig.ps1 は一覧を出すだけで、合否を返さない。
  合否にするなら「意図的な差分の許容リスト」が要る

[OsscJpDevInfra]

残していた 3 件に対応しました

前のコメントで「判断が付かない」として残した 3 件について、方針をいただいたので反映した。

いただいた判断	対応
Microsoft.AspNet.WebApi / FriendlyUrls は使っていない	メタ パッケージの行を削除（CS 2 ファイル）
Newtonsoft.Json は最新に上げるべき所を VB 未着手	VB の bindingRedirect を 13.0.0.0 へ（3 ファイル）
自動チェックは実施する	CompareConfig.ps1 -Check を実装

① 未使用のメタ パッケージを削除

調べたところ、どちらもメタ パッケージで、<Reference> は下位パッケージを指していた。

<!-- 削除した行（CS 側にだけ在った） -->
<package id="Microsoft.AspNet.WebApi" version="5.3.0" targetFramework="net48" />
<package id="Microsoft.AspNet.FriendlyUrls" version="1.0.2" targetFramework="net48" />

	<Reference> が実際に指す先
MVC_Sample	Microsoft.AspNet.WebApi.Core / .Client / .WebHost
WebForms_Sample	Microsoft.AspNet.FriendlyUrls.Core

VB 側は元からこの 2 行を持っていなかった。 削除により packages.config は 2 組とも同一になった。

② Newtonsoft.Json の bindingRedirect を実体に合わせた

実体は CS / VB とも 13.0.0.0 なのに、VB の redirect だけ 11.0.0.0 を指していた。

CS/VB の Build\Newtonsoft.Json.dll : ファイル版 13.0.3.27908 / アセンブリ版 13.0.0.0

- <bindingRedirect oldVersion="0.0.0.0-11.0.0.0" newVersion="11.0.0.0"/>
+ <bindingRedirect oldVersion="0.0.0.0-13.0.0.0" newVersion="13.0.0.0"/>

11.0.0.0 は配布されていないので、この範囲に入る要求は解決に失敗する。
（13.0.0.0 の要求は範囲外なので直接束縛され、結果的に動いていた）

対象は WSClientWin_sample / WSClientWin2_sample / WSClientWPF_sample の 3 ファイル。

③ 自動チェック（CompareConfig.ps1 -Check）

「差分の有無」ではなく「想定外の差分の有無」を見る。
差分があること自体は異常ではないので、それで落としては使い物にならない。

許容する種類をスクリプトに持たせ、当てはまらない差分が 1 件でもあれば終了コード 1。

許容する種類	理由
/configuration/startup 配下	VS が VB プロジェクトに自動で入れる
/configuration/runtime 配下	NuGet が生成する bindingRedirect
system.web/compilation/assemblies 配下	VB は明示参照が要ることがある
appSettings の SqlTextFilePath	同じにすると壊れる（言語で埋め込みリソース名の規則が違う）
appSettings の ClientSettingsProvider.*	VS のテンプレート由来

対照つきで検証した。

	結果
現状	想定外の差分なし / ExitCode=0
わざと VB の接続文字列を 1 文字変える	想定外 2 件 / ExitCode=1（該当箇所を表示）

================ 判定 ================
  **想定外の差分 2 件**

  Samples\WebApp_sample\WebForms_Sample\WebForms_Sample\Web.config
    /configuration/connectionStrings/... [connectionString=...Database=test2;...]

  意図した差分なら CompareConfig.ps1 の $allowed に足し、
  **なぜ違ってよいのかを CONFIGURATION.md 11 節にも書くこと。**

許容を増やすときに理由を書かせるのが要点。$allowed にだけ足すと、
「なぜ違ってよいのか」がスクリプトの正規表現としてしか残らない。

突き合わせの推移

	同一	差分
着手前	9	16
現在	12	13

解消したのは packages.config 2 組と WebForms_Sample/Web.config。
残る 13 組はすべて「違ってよい」種類で、-Check は想定外 0 件を返す。

検証

1_BuildAll.ps1 -Lang Both : 全ステップ OK / ExitCode=0
（既知の MSB3482（ClickOnce 署名）を -IgnoreErrors で 1 件除外）

packages.config の削除も bindingRedirect の更新も、ビルドに影響していない。

疎通では検証できない範囲である

bindingRedirect は実行時に効くが、対象の WSClient_sample 3 本は
CS / VB とも疎通テストの対象外である。

VB の疎通対象 : SimpleBatch / RerunnableBatch ×3 / MVC_Sample / WebForms_Sample

3_SmokeTest.ps1 を回してもこの変更は検証できない。
ビルドが通るところまでが、この環境で確かめられる範囲である。

この Issue の主題（CI は「意図どおり」の証拠にならない）が、
自分の変更にもそのまま当てはまった形になる。
だからこそ -Check を入れた、とも言える。

切り出したもの

#554（サンプルに、使っていない参照と陳腐化した参照が残っている）

• FriendlyUrls.Core / .Core.ja は、CS / VB とも使用箇所が全部コメントアウトされている。
  ただし CS / VB で完全に一致しており、ずれてはいないので本 Issue の対象外
• CS 側にも陳腐化した bindingRedirect がある
  （Frameworks/Tests/TestBatch/SimpleBatch/app.config が 12.0.0.0、実体は 13.0.0.0）

残していること

• #553 の①〜④は一巡した。 突き合わせ・記録・是正・再発防止のいずれも形になっている
• -Check を CI へ組み込むかは未着手。 現状は手で回す前提
  （1_BuildAll.ps1 に混ぜると、ビルドと関係のない理由で落ちることになる）

[OsscJpDevInfra]

④ の残り（自動チェックの組み込み）を実施しました

CompareConfig.ps1 -Check を 0_RunAll.ps1 に組み込み、警告として出す形にした。

どこに置いたか

0_RunAll.ps1。 3_SmokeTest.ps1 の中には入れていない。

SMOKETEST.md 2 節が、各段階の役割を定義している。

	見るもの
1_BuildAll.ps1	ビルドが通るか
2_RunAllTests.ps1	出力が前回と同じか
3_SmokeTest.ps1	起動して想定どおり動くか

設定の CS / VB 差は「起動して動くか」ではない。 ここに入れると定義が濁るうえ、
-Only で絞ったときや -SkipBuild のときにも毎回出ることになる。

0_RunAll.ps1 は検証全体の入り口なので、リポジトリの状態を見る観点はここが合う。

実装

2 か所に出す。

# 実行前
$configOk = Test-ConfigSync
if (-not $configOk)
{
    Write-Host "【警告】設定ファイルに想定外の差分があります。" -ForegroundColor Yellow
    Write-Host "        .\CompareConfig.ps1 -Check で内容を確認してください。"
}

# 全体のまとめの末尾
if (-not $configOk)
{
    Write-Host "【警告】設定ファイルに想定外の差分があります（CompareConfig.ps1 -Check）。" -ForegroundColor Yellow
    Write-Host "        合否には数えていません。CONFIGURATION.md 11 節を参照。"
}

決めたこと

	理由
合否には影響させない	#555 で「終了コードをそのまま合否として読める」ようにした直後である。ここで NG 要因を増やすと台無しになる
一覧は出さない（Out-Null）	25 行が毎回流れると、本来の検証ログが読みにくくなる。異常時だけ「見に行け」と伝える
-Lang に関わらず常に実行	比較は本質的に CS ↔ VB であり、片方だけを回すときにも意味がある。所要 4.5 秒
まとめにも出す	通しは長い。途中の警告は流れて見落とされる

検証（対照つき）

わざと想定外の差分を作って、出る側・出ない側の両方を確かめた。

① 想定外の差分なし（現状）

ExitCode = 0
**警告なし（想定どおり）**
一覧が流れていないか（突き合わせ の見出し行数） : 0

Out-Null が効き、25 行の一覧は流れていない。

② 想定外の差分あり（VB の接続文字列を 1 文字変える）

  46 行目 : 【警告】設定ファイルに想定外の差分があります。
 173 行目 : 【警告】設定ファイルに想定外の差分があります（CompareConfig.ps1 -Check）。

すべて OK です。

【警告】設定ファイルに想定外の差分があります（CompareConfig.ps1 -Check）。
        合否には数えていません。CONFIGURATION.md 11 節を参照。

警告は 2 か所に出て、合否は「すべて OK です」のまま。 狙いどおりである。

検証後、改変したファイルは finally で復元し、差分が残っていないことを確認した。

これで #553 は一巡しました

① 突き合わせ	25 組を比較。同一 9 → 12、差分 16 → 13
② 記録	CONFIGURATION.md 11 節
③ 事故を直す	コメント 2 件・接続文字列・メタ パッケージ 2 件・bindingRedirect 3 件
④ 再発防止	CompareConfig.ps1（-Check）＋ 0_RunAll.ps1 への組み込み

残る差分 13 組は、すべて「違ってよい」種類である（-Check は想定外 0 件を返す）。

参考 — この Issue から派生したもの

#554	使っていない参照（FriendlyUrls）。対応済み
#555	0_RunAll.ps1 に -IgnoreErrors が渡せない。対応済み（本件の警告を「合否に影響させない」判断は、これが前提）
#556	bindingRedirect の陳腐化 8 件。未着手

#556 で同じ考え方の CompareRedirect.ps1 を作るなら、組み込み先はここになる。