Поделиться через

Test-ModuleManifest

  • Ссылка
Модуль:
Microsoft.PowerShell.Core

Проверяет, точно ли файл манифеста модуля описывает содержимое модуля.

Синтаксис

Test-ModuleManifest
    [-Path] <String>
    [<CommonParameters>]

Описание

Командлет Test-ModuleManifest проверяет, что файлы, перечисленные в файле манифеста модуля (PSD1), фактически находятся в указанных путях.

Этот командлет предназначен для проверки файлов манифеста авторами модулей. Пользователи модулей также могут использовать этот командлет в скриптах и командах для обнаружения ошибок перед выполнением скриптов, зависящих от модуля.

Test-ModuleManifest возвращает объект, представляющий модуль. Это тот же тип объекта, который Get-Module возвращается. Если файлы не находятся в расположениях, указанных в манифесте, командлет также создает ошибку для каждого отсутствующих файла.

Примеры

Пример 1. Тестирование манифеста

test-ModuleManifest -Path "$pshome\Modules\TestModule.psd1"

Эта команда проверяет манифест модуля TestModule.psd1.

Пример 2. Тестирование манифеста с помощью конвейера

"$pshome\Modules\TestModule.psd1" | test-modulemanifest

Test-ModuleManifest : The specified type data file 'C:\Windows\System32\Wi
ndowsPowerShell\v1.0\Modules\TestModule\TestTypes.ps1xml' could not be processed because the file was not found. Please correct the path and try again.
At line:1 char:34
+ "$pshome\Modules\TestModule.psd1" | test-modulemanifest <<<<
+ CategoryInfo          : ResourceUnavailable: (C:\Windows\System32\WindowsPowerShell\v1.0\Modules\TestModule\TestTypes.ps1xml:String) [Test-ModuleManifest], FileNotFoundException
+ FullyQualifiedErrorId : Modules_TypeDataFileNotFound,Microsoft.PowerShell.Commands.TestModuleManifestCommandName

Name              : TestModule
Path              : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\TestModule\TestModule.psd1
Description       :
Guid              : 6f0f1387-cd25-4902-b7b4-22cff6aefa7b
Version           : 1.0
ModuleBase        : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\TestModule
ModuleType        : Manifest
PrivateData       :
AccessMode        : ReadWrite
ExportedAliases   : {}
ExportedCmdlets   : {}
ExportedFunctions : {}
ExportedVariables : {}
NestedModules     : {}

Эта команда использует оператор конвейера (|) для отправки строки пути в Test-ModuleManifest.

Выходные данные команды показывают, что тест завершился ошибкой, так как файл TestTypes.ps1xml, который был указан в манифесте, не найден.

Пример 3. Запись функции для тестирования манифеста модуля

function Test-ManifestBool ($path)

{$a = dir $path | Test-ModuleManifest -ErrorAction SilentlyContinue; $?}

Эта функция похожа на Test-ModuleManifest, но возвращает логическое значение. Функция возвращает $True, если манифест прошел тест и $False в противном случае.

Функция использует командлет Get-ChildItem псевдоним = dir, чтобы получить манифест модуля, указанный переменной $path. Команда использует оператор конвейера (|) для передачи объекта файла в Test-ModuleManifest.

Test-ModuleManifest использует общий параметр ErrorAction со значением SilentlyContinue для подавления отображения ошибок, создаваемых командой. Он также сохраняет объект PSModuleInfo, который Test-ModuleManifest возвращается в переменной $a. Поэтому объект не отображается.

Затем в отдельной команде функция отображает значение $? автоматическая переменная. Если предыдущая команда не создает ошибки, команда отображает $True и $False в противном случае.

Эту функцию можно использовать в условных инструкциях, таких как те, которые могут предшествовать команде import-Module или команде, которая использует модуль.

Параметры

-Path

Задает путь и имя файла манифеста. Введите необязательный путь и имя файла манифеста модуля с расширением PSD1-файла. Расположение по умолчанию — текущий каталог. Поддерживаются подстановочные знаки, но должны разрешаться в один файл манифеста модуля. Этот параметр является обязательным. Можно также передать путь к Test-ModuleManifest.

Тип:String
Position:0
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:True

Входные данные

String

Путь к манифесту модуля можно передать этому командлету.

Выходные данные

PSModuleInfo

Этот командлет возвращает объект PSModuleInfo, представляющий модуль. Он возвращает этот объект, даже если манифест имеет ошибки.