Unity開発でのミスを未然に防ぐRoslynアナライザーのすゝめ【DeNA TechCon 2022】

こちらに登壇時の映
像をいれるので、文
字を載せないように
して下さい。
Unity開発でのミスを未然に防ぐ
Roslynアナライザーのすゝめ
システム本部品質統括部品質管理部SWET第二グループ
Kazuma Inagaki

View Slide

して下さい。
自己紹介
- Kazuma Inagaki
- 21新卒
- SWETグループ所属
- Vimmer

View Slide

して下さい。
- Roslynアナライザーの概要
- Roslynアナライザーができること、使い方
- カスタムルールの作り方
- カスタムアナライザーをテストする方法
- 作成したアナライザーをUPMパッケージに内包して配布、利用する
NOTE: バージョンによってバグによる制約があるため、
このスライドではUnity 2021.2 + Rider Editor package
v3.0.9を基準に書いています。
目次

View Slide

して下さい。
Roslynアナライザーの概要
- Roslynとは
- Roslynアナライザーとは

View Slide

して下さい。
Roslynとは
- C#6.0から導入された.NETコンパイラプラットフォームの通称
- 公開されているもの
- C#、VB向けコンパイラ
- コード生成API
- コード解析API

View Slide

して下さい。
Roslynアナライザーとは
- Roslynのコード解析APIを用いて作成された、コードの問題を検出するプログ
ラムのこと

View Slide

して下さい。
コンパイラ
オレオレルール
- 型違反
- 未定義関数
- 未定義変数
- etc...
- コーディング規約
- 非推奨のAPIの使用
- etc...
一般的なルール

View Slide

して下さい。
コンパイラ
オレオレルール
- 型違反
- 未定義関数
- 未定義変数
- etc...
Roslynアナライザーに
やってもらおう！
一般的なルール

View Slide

して下さい。
どうやってやってもらうんだ..?

View Slide

して下さい。
IDE上でRoslynアナライザーを使用
IDE上にレポートされる
IDE上で欠陥を作り込む
Unity上でRoslynアナライザーを使用
ビルド時にUnityエディタ上にレポートされる
Unityを開く

View Slide

して下さい。
それだけではない！

View Slide

して下さい。
コンパイラオレオレルール
- etc...

View Slide

して下さい。
コンパイラオレオレルール
- etc...
エンジニア
誰でも診断ルールを
自作できる

View Slide

して下さい。
目次

View Slide

して下さい。
Roslynアナライザーができること、使い方
- 様々な診断ルールを持つアナライザーの紹介
- Unity上でRoslynアナライザーを使う方法
- JetBrains Rider上でRoslynアナライザーを使う方法
- アナライザーTips

View Slide

して下さい。
様々な診断ルールを持つアナライザーの紹介
- Microsoft.CodeAnalysis.BannedApiAnalyzer
- 汎用的に特定のAPIを使用禁止にできるアナライザー
- 例: UniTaskでなくTaskを使用していたら怒るルール
- codecracker.CSharp
- dispose漏れを怒るルール（CS0022）
- DeNA内で作成したアナライザー
- Preserve属性のつけ忘れを怒るルール

View Slide

して下さい。
- Preserveのつけ忘れを怒るルール

View Slide

して下さい。
public async Task M()
{
await Task.Delay(100);
}
Taskを使用した例
UniTaskを使用した例
public async UniTask M()
{
await UniTask.Delay(100);
}

View Slide

して下さい。
{
}
UniTaskでなく、Taskを使っている
{
}

View Slide

して下さい。
{
}
Do not used banned APIs
{
}

View Slide

して下さい。
- Preserveのつけ忘れを怒るルール

View Slide

して下さい。
public class MustDisposeClass : IDisposable
{
}
void M()
{
var hoge = new MustDisposeClass();
}

View Slide

して下さい。
{
}
void M()
{
}
Disposeができていない！

View Slide

して下さい。
{
}
void M()
{
}
MustDisposeClass should be
disposed.

View Slide

して下さい。
{
}
void M()
{
}

View Slide

して下さい。
{
}
void M()
{
}
using (var hoge = new MustDisposeClass())
{
}
void M()
{
hoge.Dispose();
}

View Slide

して下さい。
- Preserve属性のつけ忘れを怒るルール

View Slide

して下さい。
var services = new ServiceCollection();
services.AddSingleton();
DIコンテナへの登録

View Slide

して下さい。
public class GoodService : IGoodService
{
[Preserve]
public GoodService()
{
}
}
public class BadServiceNoInject : IBadServiceNoInject
{
public BadServiceNoInject()
{
}
}

View Slide

して下さい。
Preserve属性あり
Preserve属性なし
{
[Preserve]
{
}
}
{
{
}
}

View Slide

して下さい。
Preserve属性あり
Preserve属性なし
{
[Preserve]
{
}
}
{
{
}
}
IL2CPPでビルドした時に最適化によって、直接使用されない且つ Preserve
属性の無いコンストラクタを持つクラスはストリップされる。

View Slide

して下さい。
バグの混入ビルドするクラッシュする
public class
BadServiceNoInject :
IBadServiceNoInject
{
public
BadServiceNoInject ()
{
}
}
ビルドが成功する端末等で操作

View Slide

して下さい。
アナライザなし
アナライザあり
ビルドが失敗するミスが早く見つかる
public class
IBadServiceNoInject
{
public
{
}
}
クラッシュする
public class
IBadServiceNoInject
{
public
{
}
}
ビルドが成功する端末等で操作

View Slide

して下さい。

View Slide

して下さい。
Unity上でRoslynアナライザーを使う方法
- Unityへの導入の仕方
- Unityエディター上でのアナライザーの振る舞い

View Slide

して下さい。
dllを、Unityプロジェクト下の
任意のフォルダに配置する
Unity上で設定するアナライザーが動作する
範囲の設定をする
Unityへの導入の仕方

View Slide

して下さい。
Assets/Hoge/
├── Editor
│ └── YourLibrary.Editor.asmdef
├── Runtime
│ ├── YourLibrary.Runtime.asmdef
│ └── YourLibraryCode.cs
└── Tests
└── YourLibrary.Tests.asmdef

View Slide

して下さい。
Assets/Hoge/
├── Editor
├── Runtime
└── Tests
Assets/Hoge/
├── Analyzers
│ ├── your.library.analyzers.dll
│ └── your.library.analyzers.dll.meta
├── Editor
├── Runtime
└── Tests
Assets下の任意のディレクトリに
アナライザーのdllを配置する

View Slide

して下さい。

View Slide

Unity上での設定の仕方
1. アナライザーのDLLをProjectウィンドウで選択（インス
ペクタが開く）
2. Select Platforms for plugin下のチェックボックスをすべ
てoff
3. Applyボタンをクリック
4. 栞アイコンをクリック
5. ウィンドウに”RoslynAnalyzer”と入力し、Enterを押す

View Slide

して下さい。

View Slide

して下さい。
アナライザーが動作する範囲の設定をする
Assets/Hoge/
├── Analyzers
├── Editor
├── Runtime
└── Tests

View Slide

して下さい。
Assets/Hoge/
├── Analyzers
├── Editor
├── Runtime
└── Tests
YourLibrary.Runtimeアセンブリに含まれる
C#スクリプト（YourLibraryCode.cs）
にアナライザーを適用したい

View Slide

して下さい。
Assets/Hoge/
├── Analyzers
├── Editor
├── Runtime
└── Tests
Assets/Hoge/
├── Analyzers
│ ├── Analyzers.asmdef
│ ├── dummyFile.cs
├── Editor
├── Runtime
└── Tests
Assets下のアナライザーDLLが含まれる
ディレクトリにasmdefとダミーのC#スクリ
プトを配置する

View Slide

して下さい。
Assets/Hoge/
├── Analyzers
├── Editor
├── Runtime
└── Tests
Assets/Hoge/
├── Analyzers
├── Editor
├── Runtime
└── Tests
Analyzersを別アセンブリから参照する際にはア
センブリの生成が必要です。そのため、何かしら
のC#スクリプトを置く必要があります。

View Slide

して下さい。
Assets/Hoge/
├── Analyzers
├── Editor
├── Runtime
└── Tests
1. アナライザーを適用したい
asmdefをinspecterで開く
（無い場合はasmdef作成する）
2. Assembly Defintion Reference にアナライザーを含む
アセンブリ（Analyzers）を追加
3. applyを押す

View Slide

して下さい。
1. アナライザーを適用したい
asmdefをinspecterで開く
（無い場合はasmdef作成する）
2. Assembly Defintion Reference にアナライザーを含む
アセンブリ（Analyzers）を追加
3. applyを押す

View Slide

して下さい。
Assets/Hoge/
├── Analyzers
├── Editor
├── Runtime
└── Tests
Assets/your.library/
├── Editor
├── Runtime
└── Tests
C#コード（YourLibraryCode.cs）に
アナライザーが適用されます
。

View Slide

して下さい。
Assets/Hoge/
├── Analyzers
│ ├── your.library.analyzers.asmdef
├── Editor
├── Runtime
└── Tests
Assets/your.library/
├── Editor
├── Runtime
└── Tests
C#コード（YourLibraryCode.cs）に
アナライザーが適用されます
。

View Slide

して下さい。
Unity上でRoslynアナライザーを使う方法
- Unityへの導入の仕方
- Unityエディター上でのアナライザーの振る舞い

View Slide

して下さい。
Unityエディター上でのRoslynアナライザーの振る舞い
↑のように、重要度に応じた結果が出力される
重要度がエラーなら、コンパイルエ
ラーと同等の扱いになる

View Slide

して下さい。

View Slide

して下さい。
JetBrains Rider上でRoslynアナライザーを使う方法
Unity上にRoslynアナライザーを導
入する
Unityから、Assets | Open C#
Projectなどの操作をするだけ
NOTE: Visual Studio、
VS Codeでの動作は未検証です。

View Slide

して下さい。
JetBrains Rider上でのRoslynアナライザーの振る舞い
エディタ上に問題箇所がハイライトさ
れ、修正ポップアップに詳細が表示さ
れる
Code | Inspect Code…から実行
すれば、インスペクション結果ウィンド
ウに出力される
NOTE: Visual Studio、
VS Codeでの動作は未検証です。

View Slide

して下さい。

View Slide

して下さい。
RoslynアナライザーTips
- 重要度の設定
- Roslynアナライザーの診断を抑制する方法
- RoslynアナライザーをCI上で動かす
NOTE: Visual Studio、VS Codeでの動作は未検証です。

View Slide

して下さい。
アナライザーの診断ルールごとに診断の重要度（severity）が設定されている
- error
- warning
- suggestion
- silent
- none

View Slide

して下さい。
- CS1002: エラー
- CS0219: 警告
各アナライザにはデフォルトの重
要度が設定されている

View Slide

して下さい。
- CS1002: エラー
- CS0219: 警告
CS0219をエラーにした
いなぁ...
各アナライザにはデフォルトの重
要度が設定されている

View Slide

して下さい。
- ルールセットファイル
- ルールセットファイル
- EditorConfig ファイル
- DotSetting ファイル
重要度設定の方法
Unity JetBrains Rider

View Slide

して下さい。
ルールセットファイルによる重要度の設定
Assets/
├── your.library.analyzers.dll
├── your.library.analyzers.dll.meta
├── RethrowError.cs
├── Default.ruleset
└── Subfolder
├── Subfoloder.asmdef
└── RethrowError.cs
Assets直下に
Default.rulesetを配置する

View Slide

して下さい。
Assets/
├── your.library.analyzers.dll
├── your.library.analyzers.dll.meta
├── RethrowError.cs
├── Default.ruleset
└── Subfolder
├── Subfoloder.asmdef
└── RethrowError.cs
Assets直下に ”Default.ruleset” という名前で
ファイルを配置する

View Slide

して下さい。

View Slide

して下さい。

アナライザーのIDを指定アナライザーの重要度を上書き

View Slide

して下さい。

View Slide

して下さい。
アナライザーに怒られるコードを
仕方なく書いた
自動生成されたコードに対して
アナライザーが警告を出してしまう
なぜ抑制するのか

View Slide

して下さい。
Roslynアナライザーの診断を抑制する方法
- ファイルパス、拡張子単位での抑制（Unityでは不可能）
- クラス、メソッド単位での抑制
- ステートメント単位での抑制

View Slide

ファイルパス、拡張子単位の抑制
1. Preferences… | Editor | Inspection Settings を開く
2. Elements to Skip で除外するフォルダや拡張子のパターン
を追加する
3. Saveボタン右のプルダウンで、
Solution YOUR_PROJECT_NAME
team-shared を選択して保存

View Slide

して下さい。

View Slide

して下さい。
{
}
Do not use Task. Use the UniTask

View Slide

して下さい。
{
}
このメソッド内だけに限り
使うことを許可したいなぁ ...

View Slide

して下さい。
[SuppressMessage("ApiDesign", "RS0030")]
{
}

View Slide

して下さい。
{
}
アナライザーのID
アナライザーのカテゴリー

View Slide

して下さい。
{
}
警告を抑制出来る！
アナライザーのID
アナライザーのカテゴリー

View Slide

して下さい。

View Slide

して下さい。
{
}
Do not use Task. Use the UniTask.

View Slide

して下さい。
{
}
Do not use Task. Use the UniTask.
このステートメントに限り
警告を抑制したい

View Slide

して下さい。
{
#pragma warning disable RS0030
#pragma warning restore RS0030
}

View Slide

して下さい。
{
#pragma warning disable RS0030
#pragma warning restore RS0030
}
このステートメントに限り
抑制出来る！

View Slide

して下さい。

View Slide

コマンドラインからバッ
チモードでUnityを起動
コードをPush
注意: 一般的なlintツールとは異なり、コン
パイルログに混ざってアナライザーの診断
結果も出力される
Copyright: Jenkins project
https://jenkins.io

View Slide

して下さい。
目次
- カスタムアナライザをテストする方法

View Slide

して下さい。
カスタムルールの作り方
- ソリューションプロジェクトの作成
- 定義を検査する例
- 呼び出しを検査する例

View Slide

ソリューション・プロジェクトを作成する
1. ソリューションを作成する
2. Analyzerのプロジェクトを作成する
3. プロジェクトをソリューションに追加する
4. 必要なパッケージをインストールする
RoslynToyAnalyzer
├── RoslynToyAnalyzer
│ ├── RoslynToyAnalyzer.csproj
│ └── RoslynToyAnalyzer.cs
└── RoslynToyAnalyzers.sln
実行コマンド
dotnet new sln -o RoslynToyAnalyzer

View Slide

RoslynToyAnalyzer
実行コマンド
dotnet new classlib -o RoslynToyAnalyzer

View Slide

RoslynToyAnalyzer
実行コマンド
dotnet sln add RoslynToyAnalyzer/RoslynToyAnalyzer.csproj

View Slide

RoslynToyAnalyzer
実行コマンド
dotnet add RoslynToyAnalyzer package Microsoft.CodeAnalysis.Analyzers --version 3.3.2
dotnet add RoslynToyAnalyzer package Microsoft.CodeAnalysis.CSharp --version 3.5.0

View Slide

して下さい。

View Slide

して下さい。
定義を検査する例
public class Foo
{
}
NamedTypeのシンボル名に小文字を含む命
名に対して警告を出す

View Slide

して下さい。
public class Foo
{
}
NamedTypeのシンボル名に小文字を含んだ
名前 Foo が使用されています。

View Slide

して下さい。
public class Foo
{
}
NamedTypeって何？

View Slide

して下さい。
public class Foo
{
}
NamedTypeはclass、Enum、struct、
Interfaceを含んだシンボルの名前を意味し
ます。

View Slide

して下さい。
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using Microsoft.CodeAnalysis.Diagnostics;
using System.Collections.Immutable;
using System.Linq;
namespace RoslynToyAnalyzer
{
[DiagnosticAnalyzer(LanguageNames.CSharp)]
public class RoslynToyAnalyzer : DiagnosticAnalyzer
{
private static readonly DiagnosticDescriptor _toyRule = new DiagnosticDescriptor(
id: "TOY001",
title: "NamedTypeのシンボルに小文字を含む命名を禁止するアナライザー",
messageFormat: "NamedTypeのシンボルに小文字を含んだ命名 {0} が使用されています",
category: "RoslynToyAnalyzer",
defaultSeverity: DiagnosticSeverity.Error,
isEnabledByDefault: true);
public override ImmutableArray SupportedDiagnostics
{
get { return ImmutableArray.Create(_toyRule); }
}
public override void Initialize(AnalysisContext context)
{
context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
context.EnableConcurrentExecution();
context.RegisterSymbolAction(AnalyzeSymbol, SymbolKind.NamedType);
}
private static void AnalyzeSymbol(SymbolAnalysisContext context)
{
var namedTypeSymbol = (INamedTypeSymbol)context.Symbol;
if (namedTypeSymbol.Name.ToCharArray().Any(char.IsLower))
{
var diagnostic = Diagnostic.Create(
_toyRule,
namedTypeSymbol.Locations[0],
namedTypeSymbol.Name);
context.ReportDiagnostic(diagnostic);
}
}
}

View Slide

して下さい。
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using System.Linq;
{
{
id: "TOY001",
title: "NamedTypeのシンボルに小文字を含む命名を禁止するアナライザー",
messageFormat: "NamedTypeのシンボルに小文字を含んだ命名 {0} が使用されています",
{
}
{
}
{
{
_toyRule,
}
}
}
アナライザークラス
アナライザーの診断ルールの宣言
SupportedDiagnosticsプロパティ（必須プロパティ）
Initializeメソッド（必須メソッド）
実際の診断を行うメソッドの実装

View Slide

して下さい。
{
{
}
{
}
}
アナライザーのベースとなるクラスを継承
DiagnosticAnalyzer属性をつける
SupportedDiagnosticsメソッドの実装が必要（後述）
Initializeメソッドの実装が必要（後述）
アナライザークラスの作成

View Slide

して下さい。
id: "TOY001",
title: "NamedTypeのシンボルに小文字を含む命名を禁止するアナライザー
",
messageFormat: "NamedTypeのシンボルに小文字を含んだ命名 {0} が使用されています
",
アナライザーのカテゴリを指定
診断時に出力する警告文のテンプレートを定義
デフォルトの重要度を設定
デフォルトで診断が有効な場合はtrueを返す
アナライザーの診断ルールの宣言
アナライザーのIDを指定診断内容を説明するタイトル

View Slide

して下さい。
{
}
作成したアナライザが提供するアナライザーの一覧を配列で返す
SupportedDiagnosticsプロパティの実装（必須）
DiagnosticAnalyzerを継承したので、SupportedDiagnosticsプロパティの実装が必要

View Slide

して下さい。
{
}
コールバックを受け取りたい契機をAnalysisContextに登録する
Initializeメソッドの実装（必須）
Roslynコンパイラによってアナライザーがロードされると呼ばれるメソッド
DiagnosticAnalyzerを継承したので、Initializeメソッドの実装が必要
シンボルの意味解析ごとに動作させたいメソッド
”AnalyzeSymbol”を、”RegisterSymbolAction”で登録

View Slide

して下さい。
{
{
_toyRule,
}
}
診断に必要な情報を取得
診断結果を作成して返す
シンボルの名前に小文字を含むか判定

View Slide

して下さい。

View Slide

して下さい。
呼び出しを検査する例
var hoge = new ArrayList();
System.Collections.ArrayListをインスタン
ス化しています。
System.Collections.Generic.Listを代わりに
使用してください。

View Slide

して下さい。
using System.Collections.Generic;
using Microsoft.CodeAnalysis.Operations;
{
{
private static readonly DiagnosticDescriptor _toyRule2 = new DiagnosticDescriptor(
id: "TOY002",
title: "System.Collections.ArrayListのインスタンス作成を禁止するアナライザー ",
messageFormat: "System.Collections.ArrayListをインスタンス化しています。 System.Collections.Generic.Listを代わりに使用してくださ
い。",
{
get { return ImmutableArray.Create(_toyRule2); }
}
{
context.RegisterOperationAction(AnalyzeCreationObject, OperationKind.ObjectCreation);
}
private static void AnalyzeCreationObject(OperationAnalysisContext context)
{
var operation = (IObjectCreationOperation)context.Operation;
var symbol = operation.Type;
var symbolFullName = GetSymbolFullName(symbol);
if (symbolFullName != "System.Collections.ArrayList") return;
_toyRule2,
operation.Syntax.GetLocation(),
symbol.Name);
}
private static string GetSymbolFullName(INamespaceOrTypeSymbol symbol)
{
var collectedNamespace = new List();
while (symbol.Name != "")
{
collectedNamespace.Add(symbol.Name);
symbol = symbol.ContainingNamespace;
}
collectedNamespace.Reverse();
return string.Join(".", collectedNamespace);
}
}
}

View Slide

して下さい。
using System.Collections.Generic;
using Microsoft.CodeAnalysis.Operations;
{
{
private static readonly DiagnosticDescriptor _toyRule2 = new DiagnosticDescriptor(
id: "TOY002",
title: "System.Collections.ArrayListのインスタンス作成を禁止するアナライザー ",
messageFormat: "System.Collections.ArrayListをインスタンス化しています。 System.Collections.Generic.Listを代わりに使用してくださ
い。",
{
get { return ImmutableArray.Create(_toyRule2); }
}
{
}
{
_toyRule2,
symbol.Name);
}
{
{
}
}
}
}
Initializeメソッド（必須メソッド）
実際の診断を行うメソッド
完全修飾型名の取得

View Slide

して下さい。
{
}
コールバックを受け取りたい契機をAnalysisContextに登録する
Roslynコンパイラによってアナライザーがロードされると呼ばれるメソッド
DiagnosticAnalyzerを継承したので、Initializeメソッドの実装が必要
オブジェクトのインスタンスが作成されるごとに動作させたいメソッド
”AnalyzeCreationObject”を、”RegisterOperationAction”で登録

View Slide

して下さい。
{
}
- メソッド呼び出し（Invocation）
- 変数初期化（VariableInitializer）
- 配列の作成（ArrayCreation）
- Etc…
See also:
https://docs.microsoft.com/ja-jp/dotnet/api/microsoft.codeanalysis.operationkind

View Slide

して下さい。
{
_toyRule2,
symbol.Name);
}
診断に必要な情報を取得
診断結果を作成して返す
シンボルの完全修飾型名を取得（後述）
シンボルの型を取得

View Slide

して下さい。
{
{
}
}
シンボルの完全修飾型名を取得するメソッドの実装
.を連結して文字列として返す
シンボルの型を再帰的にたどる
NOTE: .NETでは完全修飾型名には”.”以外の
文字列が含まれますが、Roslynの既存実装で
は”+”を使っていないため、それに合わせて
います。

View Slide

して下さい。
目次
- カスタムアナライザをテストする方法

View Slide

して下さい。
カスタムアナライザーをテストする
- テストコードの解説
- テストを簡単に書くTips

View Slide

1. テストのプロジェクトを作成
2. テストプロジェクトをソリューションに追加
3. テストコードプロジェクトからの参照を追加
4. テストに必要なパッケージをインストール
RoslynToyAnalyzer
│ ├── RoslynToyAnalyzer.cs
│ └── RoslynToyAnalyzer.csproj
├── RoslynToyAnalyzer.Test
│ ├── RoslynToyAnalyzer.Test.csproj
│ └── RoslynToyAnalyzerTest.cs
実行コマンド

View Slide

2. テストプロジェクトをソリューションに追加
RoslynToyAnalyzer
実行コマンド
dotnet new nunit -o RoslynToyAnalyzer.Test

View Slide

2. テストプロジェクトをソリューションへ追加
RoslynToyAnalyzer
実行コマンド
dotnet sln RoslynToyAnalyzers.sln add RoslynToyAnalyzer.Test/RoslynToyAnalyzer.Test.csproj

View Slide

RoslynToyAnalyzer
実行コマンド
dotnet add RoslynToyAnalyzer.Test/RoslynToyAnalyzer.Test.csproj reference RoslynToyAnalyzer/RoslynToyAnalyzer.csproj

View Slide

RoslynToyAnalyzer
実行コマンド
dotnet add RoslynToyAnalyzer.Test package Microsoft.CodeAnalysis.Analyzers --version 3.3.2
dotnet add RoslynToyAnalyzer.Test package Microsoft.CodeAnalysis.CSharp --version 3.5.0
dotnet add RoslynToyAnalyzer.Test package Microsoft.CodeAnalysis.CSharp.Workspaces --version 3.5.0
dotnet add RoslynToyAnalyzer.Test package Dena.CodeAnalysis.Testing --version 2.0.0

View Slide

RoslynToyAnalyzer
実行コマンド
dotnet add RoslynToyAnalyzer.Test package Microsoft.CodeAnalysis.CSharp.Analyzer.Testing.MSTest --version 1.1.0
dotnet add RoslynToyAnalyzer.Test package Microsoft.CodeAnalysis.CSharp.CodeFix.Testing.MSTest --version 1.1.0
dotnet add RoslynToyAnalyzer.Test package Microsoft.CodeAnalysis.CSharp.CodeRefactoring.Testing.MSTest --version 1.1.0
実行コマンド

View Slide

して下さい。
今回はNUnitを用いて説明します

View Slide

して下さい。
using System.Linq;
using System.Threading.Tasks;
using Dena.CodeAnalysis.CSharp.Testing;
using Microsoft.CodeAnalysis.Text;
using NUnit.Framework;
namespace RoslynToyAnalyzer.Test
{
public class RoslynToyAnalyzerTest
{
　　　　[Test]
public async Task RoslynToyAnalyzer_クラスのシンボル名に小文字を含む_Toy001がレポートされる()
{
const string testData = @"
///
public static class Foo
{
}
";
var analyzer = new RoslynToyAnalyzer();
var actual = await DiagnosticAnalyzerRunner.Run(analyzer, testData);
Assert.AreEqual(1, actual.Length);
Assert.AreEqual("TOY001", actual.First().Id);
Assert.AreEqual("NamedTypeのシンボルに小文字を含んだ命名 Foo が使用されています", actual.First().GetMessage());
LocationAssert.HaveTheSpan(
new LinePosition(2, 20),
actual.First().Location);
}
}
}

View Slide

して下さい。
using System.Linq;
using System.Threading.Tasks;
using Dena.CodeAnalysis.CSharp.Testing;
using Microsoft.CodeAnalysis.Text;
using NUnit.Framework;
namespace RoslynToyAnalyzer.Test
{
{
　　　　[Test]
public async Task RoslynToyAnalyzer_クラスのシンボル名に小文字を含む_Toy001がレポートされる()
{
///
{
}
";
Assert.AreEqual("NamedTypeのシンボルに小文字を含んだ命名 Foo が使用されています", actual.First().GetMessage());
}
}
}
テストメソッドの準備
テストデータの準備
テストの実行
期待値と実測値の比較

View Slide

して下さい。
{
　　　　[Test]
public async Task RoslynToyAnalyzer_クラスのシンボル名に小文字を含む
_Toy001がレポートされる()
{
// ここにテストを書いていく
}
}
テストメソッドの準備
テストメソッドに[Test]属性をつける

View Slide

して下さい。
///
{
}
";
アナライザーの診断対象として渡すC#のコードを記述

View Slide

して下さい。
テストの実行
テスト対象のアナライザーのインスタンスを作成
アナライザーのインスタンスとテストデータを渡し、実測値を取得
（DeNAがOSSとして公開しているパッケージです）
See also: https://github.com/DeNA/Dena.CodeAnalysis.Testing

View Slide

して下さい。
Assert.AreEqual("NamedTypeのシンボルに小文字を含んだ命名 Foo が使用されています
", actual.First().GetMessage());
new LinePosition(2, 20), // 期待する始点
new LinePosition(2, 23), // 期待する終点
実測値と期待値の比較
アナライザーが出力した警告の数と期待値を比較
診断結果に含まれる解析対象の位置と期待値（始点と終点）を比較
（DeNAがOSSとして公開しているパッケージです）
See also: https://github.com/DeNA/Dena.CodeAnalysis.Testing
アナライザーのIDと期待値を比較
アナライザーが出力した警告文と期待値を比較
差分表示例

View Slide

して下さい。

View Slide

して下さい。
これまでに紹介したテストの問題点
- 警告される位置がわかりにくい
- 一度にAssertをたくさんしている

View Slide

して下さい。
///
{
}
";
アナライザーの診断対象として渡すC#のコードを記述

View Slide

して下さい。
///
{
}
";
どの部分がアナライザーに怒られることを期待するのかわからない...
テストの意図が、テストデータを見ただけで分かりづらい...

View Slide

して下さい。
public static class {|Foo|TOY001|クラス名のシンボルに小文字を含んだ命名 Foo が使用されています
|}
{
}
{
}
参考
https://github.com/dotnet/roslyn-analyzers/blob/main/src/Microsoft.CodeAnalysis.BannedApiAnalyzers/UnitTests/SymbolIsBannedAnalyzerTests.cs

View Slide

して下さい。
|}
{
}
{
}
警告が出る箇所の期待値
警告が出る位置
期待するアナライザー
のID
期待する警告文
参考

View Slide

して下さい。
|}
{
}
{
}
のID
マーカーを抽出する
参考

View Slide

して下さい。
|}
{
}
{
}
のID
マーカーを抽出する
マーカーを除外し、ソースコードを
作成
マーカーから期待値（DiagnosticのList）
を作成
参考

View Slide

して下さい。
|}
{
}
{
}
のID
マーカーを除外し、ソースコードを
作成
マーカーから期待値（DiagnosticのList）
を作成
アサーションで実測値と比較する
アナライザーに渡し、実測値を作成する
参考

View Slide

して下さい。
　　　　var analyzer = new RoslynToyAnalyzer();
　　　　var (source, expectedDiagnostics) =
　　　　ReadAndParseTestData.CreateSourceAndExpectedDiagnosticFromFile(@"
///
public static class {|Foo|TOY001|NamedTypeのシンボルに小文字を含んだ命名 Foo が使用されています
|}
{
}
");
　　　　var actualDiagnostics = await DiagnosticAnalyzerRunner.Run(
analyzer,
source
　　　　);
テストの意図が、テストデータを見ただけでわかる！
テストの期待値をマーカーから自動で生成できる！

View Slide

して下さい。
これまでに紹介したテストの問題点
- 警告される位置がわかりにくい
- 一度にAssertをたくさんしている

View Slide

して下さい。
Assert.AreEqual(expectedDiagnostics.Count, actualDiagnostics.Length);
Assert.AreEqual(expectedDiagnostics.First().Id, actualDiagnostics.First().Id);
Assert.AreEqual(expectedDiagnostics.First().GetMessage(), actualDiagnostics.First().GetMessage());
Assert.AreEqual(expectedDiagnostics.First().Location.GetLineSpan(), actualDiagnostics.First().Location.GetLineSpan());
Assertを一度にたくさんしている

View Slide

して下さい。
- レポートされた問題の数
- レポートされた問題のファイル内の位置
- アナライザーの ID
- レポートされた問題を人間にわかりやすく説明したメッ
セージ
を比較している。

View Slide

して下さい。
これらを一度に比較したい！

View Slide

して下さい。

View Slide

して下さい。
DiagnosticsAssert.AreEqual(IEnumerable expected, IEnumerable actual);
レポートされた問題の数（ DiagnosticのIEnumerableの個数）
レポートされた問題のファイル内の位置（ファイルパス含む）
アナライザーの ID
メッセージ
の4つの観点を比較している

View Slide

して下さい。
DiagnosticsAssert.AreEqual(IEnumerable expected, IEnumerable actual);
レポートされた問題の数（ DiagnosticのIEnumerableの個数）
レポートされた問題のファイル内の位置（ファイルパス含む）
アナライザーの ID
メッセージ
の4つの観点を比較している
Assert.Fail failed. Missing 1 diagnostics, extra 1 diagnostics of all 1 diagnostics:
missing path/to/file1.cs: (1,2)-(3,4), CS1001, Identifier expected
extra path/to/file2.cs: (5,6)-(7,8), CS1002, ; expected
出力例

View Slide

して下さい。
目次

View Slide

して下さい。
アナライザーをUPMパッケージとして配布、利用する
- 配布する方法
- 利用する方法

View Slide

して下さい。
アナライザを作成
楽に配布したい
気軽に使ってほしい

View Slide

して下さい。
配布する方法
UPMパッケージを配布用に作成する Roslynアナライザーのdllを内包する
OpenUPM、gitリポジトリ等で配布する
自作UPMパッケージ Roslynアナライザーのdllを同梱する

View Slide

して下さい。
アナライザーをUPMパッケージとして配布、利用する
- 配布する方法
- 利用する方法

View Slide

して下さい。
UPMパッケージを
インストールする
Asmdefの参照によるスコープ設定
NOTE: 既出のスライドを参照
NOTE:
Code Editor Package for VS v1.2.4以降、Code Editor Package for VSCode v2.0.11以降でも利
用可能
利用する方法

View Slide

して下さい。

View Slide

して下さい。
Roslynアナライザーは...
コンパイラが検知できない
欠陥を検知できる
自作、配布が
簡単にできる
ニーズに合った
利用ができる

View Slide

して下さい。
参考にしたサイト
- Unityプロジェクト向けRoslynアナライザの作り方
- https://swet.dena.com/entry/2021/05/25/100000
- カスタムRoslyn AnalyzerをUPMパッケージとして配布する
- https://www.nowsprinting.com/entry/2021/11/01/083258
- Unity 2020.時点のRoslyn Analyzerサポート状況まとめ
- https://www.nowsprinting.com/entry/2021/04/18/200619
- https://github.com/dotnet/roslyn-analyzers/tree/main/src/Microsoft.CodeAnalysis.BannedApiAnalyzers
- https://github.com/code-cracker/code-cracker
- UniTask
- https://github.com/Cysharp/UniTask

View Slide

して下さい。

View Slide

Unity開発でのミスを未然に防ぐRoslynアナライザーのすゝめ【DeNA TechCon 2022】

Unity開発でのミスを未然に防ぐRoslynアナライザーのすゝめ【DeNA TechCon 2022】

DeNA_Tech

More Decks by DeNA_Tech

Other Decks in Technology

Featured

Transcript