SIMY SQMの使い方｜変更を確認し品質証跡を残す

SQMが確認する範囲

SQM（Software Quality Monitor）は、登録された防止策のうち、変更に適用されるルールを確認します。利用には接続と組織側の権限・設定を確認してください。ルールが適用されなかった結果と、ルールを実際に評価して合格した結果は区別します。

画面操作や公開後の動作をすべて自動で証明するものではありません。プロジェクトのテスト、利用者の動線確認、独立レビューとあわせて使います。

同じ差分で、二段階の確認を実行

CLIを利用できるリポジトリのルートで、まず差分の事前確認、その後に本チェックを実行します。次はmacOS/Linuxの例です。origin/mainは実際のPRの基準ブランチに置き換えます。証跡の保存先はリポジトリの外に作っておきます。

mkdir -p /tmp/simy-sqm-proof
simy sqm min-check --base origin/main --output /tmp/simy-sqm-proof/min.json
simy sqm check --base origin/main --min-result /tmp/simy-sqm-proof/min.json --proof /tmp/simy-sqm-proof/proof.json --signed-evidence /tmp/simy-sqm-proof/proof.signed.json --no-upload

二つのコマンドの間では、対象のファイルを変更しません。変更すると事前確認と本チェックの対象がずれ、証跡をそのまま使えなくなります。利用中のバージョンでsimy sqm --helpも確認してください。

この例では--no-uploadで実行証跡のクラウド送信を止めています。通常は証跡が送信されるため、共有先を確認して使い分けてください。

結果を見るときの例

outcome.statusがpassedでも、それだけで機能全体の品質を証明したとは言えません。no_applicable_rulesや評価件数ゼロなら、今回の差分に適用された評価がないことを明示します。失敗や利用不可も合格として扱いません。

依頼文の例

レビューに渡す前に確認すること

証跡にはリポジトリや変更の情報が含まれます。保管先と共有範囲を確認し、公開資料に内部の情報をそのまま貼り付けないようにします。レビューには、その変更に対応する証跡と実際のテスト結果を渡してください。

• 対象のリポジトリ、基準ブランチ、HEAD、作業ツリーが実際の候補と一致している。
• 署名と証跡の対応をSQMの検証機能で確認できている。
• 適用モジュール、ルール件数、シナリオ結果が分かり、必須と参考の結果を分けている。
• チェック後に差分や基準が変わったら、最新の状態で再実行している。

次に読む