NuGetパッケージのデバッグのバックアップ(No.9) - マイクロソフト系技術情報 Wiki

[ トップ ] [ 新規 | 一覧 | 単語検索 | 最終更新 | ヘルプ ]

「マイクロソフト系技術情報 Wiki」は、「Open棟梁Project」,「OSSコンソーシアム .NET開発基盤部会」によって運営されています。

戻る

目次 †

目次
概要
パッケージの登録
- （Primary packageに）PDBを同梱
  - ポイント
  - 手順
- Symbol Packageを利用
パッケージのデバッグ
- （Primary packageに）PDBを同梱
- Symbol Packageを利用
参考

概要 †

NuGetパッケージで展開されているモジュール内の
デバッグ実行が必要になった時の手順も確立しておく必要がある。

以下の2つの方法がある。
- （Primary packageに）PDBを同梱
- Symbol Packageを利用

パッケージの登録 †

（Primary packageに）PDBを同梱 †

「NuGetパッケージの開発と公開」を参照。

ポイント †

'*.pdbファイル以外のすべてのファイル（*.dll、*.pdb、*.xml）を含める。
'*.pdbを同梱する場合は、ビルド時のフォルダ構成に注意すること（開発環境と一致させる）。
ただし「ビルド環境と開発環境のソースファイルパスを一致させる（PDB）。」で対応できる。

手順 †

nuspecファイルの書き方の例

NuGetパッケージの作成方法

パッケージ名
{identifier}.nupkg

Symbol Packageを利用 †

NuGetは、Symbol Packageを作成し、SymbolSource?リポジトリに公開することもサポート

ポイント †

*.dll、*.pdb、*.xmlに加え、ソースファイル（任意）を同梱。
libフォルダの構造はPrimary packageと完全に同じにする。
追加で、ソースファイルのルートフォルダをsrcに指定する。

準備 †

nuspecファイルの書き方の例（srcはソースファイルのルートフォルダ）

<files>
    <file src="Full\bin\Debug\*.dll" target="lib\net40" />
    <file src="Full\bin\Debug\*.pdb" target="lib\net40" />
    <file src="Silverlight\bin\Debug\*.dll" target="lib\sl40" />
    <file src="Silverlight\bin\Debug\*.pdb" target="lib\sl40" />
    <file src="**\*.cs" target="src" />
</files>

nuspecファイルは、Primary PackageとSymbol Packageで共有（１つ）で良い（理由は後述）。
「src="**\*.cs"」の「**」は、再帰的にフォルダを検索することを意味するので、
- 階層構造がある src でも正しく同梱することが可能。
- 必要であれば、作成したPackageを解凍して、同梱されるソースファイルを確認できる。

作成方法
- 以下のコマンドで、symbolとsrcが除外されたPrimary Packageと、Symbol Packageが生成される。
```
nuget pack [*.nuspecファイルパス] -Symbols
```
- Primary Packageにもsymbolとsrcを含めたい場合、別途、以下のコマンドを実行する。
```
nuget pack [*.nuspecファイルパス]
```

パッケージ名
{identifier}.symbols.nupkg

登録 †

概要
- NuGetプロトコルを実装するnuget.exe v4.1.0以上を使用
- nuget.orgとsymbolsource.orgの両方に登録を行う。

操作

便宜上、NuGetを使用してAPIキーを保存
```
nuget SetApiKey Your-API-Key
```

Symbol Packageをプッシュ

Primary packageをプッシュした後に、Symbol Packageをプッシュ
（*.symbols.nupkgとあれば自動的にsymbolsource.orgがターゲットになる。）
```
nuget push *.symbols.nupkg
```

Sourceオプションを使用して、Symbol Repositoryにプッシュ
Symbol Packageを別のSymbol Repositoryにプッシュ
若しくは、命名規則に従わないSymbol PackageをSymbol Repositoryにプッシュ
```
nuget push *.symbols.nupkg -source https://nuget.smbsrc.net/
```

Primary package、Symbol Packageの両方をプッシュ
Primary package、Symbol Packageの両方を、同時に両方のRepositoryにプッシュすることもできる。
```
nuget push *.nupkg
```

nuget.exe 4.5.0以降、
Primary package、Symbol Packageを[-source]を指定して個別にプッシュ。

nuget SetApiKey [ApiKey]
nuget push *.nupkg -Source https://api.nuget.org/v3/index.json
nuget push *.symbols.nupkg -source https://nuget.smbsrc.net/

※ https://nuget.smbsrc.net/ は、symbolsource.orgのプッシュURL。

nuget push 補足説明 †

nuget.exe による、*.symbols.nupkg の push の補足説明

symbolsource.orgへのサインイン
- SetApiKey? で保存された APIキーを nuget.org と symbolsource.org の両方に対して使用する。
- symbolsource.org ではこの API キーを使用して nuget.org へ確認するため、
  symbolsource.org にサインインせずSymbol Packageのアップロードが可能。

PDB ファイルの書換
nuget.exe push で　symbolsource.org に push された際、
- XXXX側のPDB ファイルのソースの検索方法が書き換えられ、
- ソースの検索先が symbolsource.org になる。

パッケージのデバッグ †

（Primary packageに）PDBを同梱 †

*.pdbファイルが同梱されていれば、そのままデバッグ可能。
ただし、ソースファイルの配置については考慮が必要。

Symbol Packageを利用 †

*.pdbファイルとソースファイルを自動的に取得してソースコードのステップインが可能

ただし、以下の設定が必要になる。

「シンボルサーバ」、「ソースサーバ」を有効にする。
[ツール] ---> [オプション] ---> [デバッグ] ---> [全般]
- [マイコードのみを有効にする]のチェックを外す。
- [.NET Framework ソースのステッピングを有効にする]のチェックを外す。

ソースサーバのサポートを有効にする。

ソースサーバ、シンボルサーバの場所を追加する。
- https://www.symbolsource.org/Public/Wiki/Using
  （同じバイナリのシンボルが含まれている場合があるため、順序に注意する。）
  1. http://referencesource.microsoft.com/symbols
  2. http://srv.symbolsource.org/pdb/Public
    or the authenticated variant (see above)
  3. http://srv.symbolsource.org/pdb/MyGet
    or the authenticated variant (see above)
  4. (other symbol servers with sources)
  5. http://msdl.microsoft.com/download/symbols
  6. (other symbol servers without sources)

参考 †

Microsoft Docs †

NuGet パッケージの作成方法
https://docs.microsof.com/ja-jp/nuget/create-packages/creating-a-package
- NuGet パッケージのプレリリース版
  https://docs.microsoft.com/ja-jp/nuget/create-packages/prerelease-packages
- NuGet シンボルパッケージの作成方法
  https://docs.microsoft.com/ja-jp/nuget/create-packages/symbol-packages

NuGet パッケージの公開方法
https://docs.microsoft.com/ja-jp/nuget/create-packages/publish-a-package

NuGet Command-Line Interface (CLI) Reference
https://docs.microsoft.com/en-us/nuget/tools/nuget-exe-cli-reference
- NuGet CLI pack command
  https://docs.microsoft.com/en-us/nuget/tools/cli-ref-pack
- NuGet CLI push command
  https://docs.microsoft.com/en-us/nuget/tools/cli-ref-push

SymbolSource?.org †

Your source for debugging symbols... and sources.

HOME | What does it do?
https://www.symbolsource.org/Public/
Help | Using
https://www.symbolsource.org/Public/Wiki/Using

Register
https://www.symbolsource.org/Public/Account/Register

Metadata
- Public
  http://www.symbolsource.org/Public/Metadata
- MyGet?
  http://www.symbolsource.org/MyGet/Metadata

デバッグ可能なNuGetパッケージのサンプル †

https://github.com/OpenTouryoProject/SampleProgram/tree/master/NeGet

ビルド環境と開発環境のソースファイルパスを一致させる（PDB）。 †

Tags: :.NET開発, :デプロイ, :デバッグ, :NuGet