Skip to content

docs: テストFWガイドのコンパイル不能なコード例と設定手順の事実誤りを修正 - #731

Open
kumagoro1202 wants to merge 1 commit into
developfrom
docs/cmd685-pending6-fixes
Open

docs: テストFWガイドのコンパイル不能なコード例と設定手順の事実誤りを修正#731
kumagoro1202 wants to merge 1 commit into
developfrom
docs/cmd685-pending6-fixes

Conversation

@kumagoro1202

Copy link
Copy Markdown
Contributor

概要

日本語ドキュメントの逐語検証で見つかった、実装と一致しない記述4件(+同型1件)を修正します。全て実コード・実設定ファイルで裏取り済みです。

修正内容

1. 06_TestFWGuide/02_DbAccessTest.rst: assertSqlResultSetEquals の引数不足

コード例が3引数呼び出し assertSqlResultSetEquals("testSelectAll", "expected", actual) になっていましたが、DbAccessTestSupport に該当するオーバーロードは存在せず(nablarch-testingDbAccessTestSupport.java には assertSqlResultSetEquals(String message, String sheetName, String id, SqlResultSet actual) の4引数版のみ)、このままではコンパイルできません。第1引数に比較失敗時のメッセージを補い4引数化し、直前のコメントも実引数に合わせました。

2. 06_TestFWGuide/03_Tips.rst(L140付近): 同メソッドの同問題

ループ内の3引数呼び出しを同様に4引数化しました。メッセージはページの簡潔なトーンに合わせた固定文言としています。

また、同ファイル後半(L611付近、委譲パターンの例 dbSupport.assertSqlResultSetEquals("test", "id", actual))にも同型の3引数呼び出しがあったため、併せて4引数化しています。

3. 06_TestFWGuide/03_Tips.rst(L364付近): 実在しないFQCN

nablarch.common.idgenerator.OracleSequenceIdGenerator は実在しません。実在するのはサンプル実装(nablarch-report-sample)の please.change.me.common.idgenerator.OracleSequenceIdGeneratorSequenceIdGeneratorSupport 継承・idTable プロパティも設定例と一致)のみのため、実FQCNへ修正しました。
なお同節の nablarch.common.idgenerator.FastTableIdGenerator(L380付近)は nablarch-common-idgenerator-jdbc に実在する標準クラスであり、プロパティ名(tableName/idColumnName/noColumnName/dbTransactionManager)も実装と一致するため変更していません。

4. CustomizeMessageIDAndMessage.rst: メッセージID紐付け手順の事実誤り

src/main/resources/common.propertiesnablarch.zenkakuCharset.messageId=M000000017 が記述されている」とありますが、現行のアーキタイプ生成プロジェクトの common.properties にこの項目は存在しません。実際のデフォルト値は nablarch-main-default-configuration 内の nablarch/core/validation/charset-definition-message-id.configerrors.zenkakuCharset と定義され、charset-definition.xml(各アーキタイプの component-configuration が import)が読み込んで ${nablarch.zenkakuCharset.messageId} プレースホルダで参照する構成です。環境設定値は後勝ち(重複キーは後に定義されたものが有効)で、各アーキタイプとも common.properties の読み込みが import より後にあるため、プロジェクト側で同キーを定義して上書きする手順に書き直しました。

確認

  • 変更3ファイルに対して textlint(リポジトリ設定 .textlintrc)を実行しエラー0件
  • linter が機能していることを .textlint/test/test.rst(既知のエラーを含むファイル)で検出確認済み

- 02_DbAccessTest.rst / 03_Tips.rst: assertSqlResultSetEqualsの3引数
  呼び出しを実在する4引数版(message, sheetName, id, actual)に修正
- 03_Tips.rst: 実在しないFQCN nablarch.common.idgenerator.
  OracleSequenceIdGeneratorをサンプル実装の実FQCN
  (please.change.me.common.idgenerator.OracleSequenceIdGenerator)に修正
- CustomizeMessageIDAndMessage.rst: メッセージID紐付けの設定箇所を
  現行実装(nablarch-main-default-configurationのcharset-definition-
  message-id.config、デフォルト値errors.zenkakuCharset)に合わせて
  手順を書き直し
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.

1 participant