Богдан Стефанюк: дописи з тегом powershell

Работа с файлами в Powershell

Wed, 19 Jun 2019 08:35:12 -0400

Получение списка файлов

Get-ChildItem $path — отобразит список файлов по указанному пути.
Get-ChildItem -Force $path — отобразит список файлов (включая скрытые) по указанному пути.
Get-ChildItem -Force $path -Recurse — отобразит список всех файлов, а также вложенных.

Копирование файлов и папок

New-Item -Path $path -ItemType «directory | file» — создает объект в файловой системе.

Удаление всех файлов и папок, содержащихся в папке

Remove-Item $path — удалит все файлы по указанному пути, но будет предлагать подтверждения.
Remove-Item $path -Recurse — удалит все файлы без подтверждения.

Работа с содержимым файла

Get-Content -Path $path — вычитать содержимое файла.
Add-Content -Path $path «Additional content» — дописывает в конец файла текст.
Set-Content -Path $path -Value «New content» — позволяет перезаписать содержимое файла
Get-Date | Set-Content $path — также можно использовать в качестве пайпалайна
Out-File -FilePath $path — отправляет вывод в файл.
Out-File -FilePath $path -Append — дописывает данные в конец файла

Автоматизация релизов Github с помощью Powershell и Teamcity

Tue, 14 May 2019 07:03:53 -0400

Совсем недавно о одном open-source проекте, в котором я участвую, потребовалось автоматизировать создание релизов на Github. В моем распоряжении есть TeamCity. Решил написать небольшой план, который состоит из следующих шагов:

Выкачать проект.
Скомпилировать.
Опубликовать Release версию в папку.
Собрать артефакт Teamcity.
Упаковать билд в архив.
Создать страницу релиза на Github с описанием.
Выгрузить на страницу архив с билдом.

Для решения 5-6 пунктов был написан простой powershell скрипт, который можно посмотреть по этой ссылке.

P.S. В дальнейшем, в репозиторий буду добавлять друге полезные скрипты.
Ссылка на репозиторий: https://github.com/teamkiller7112/PowerShellScriptsArchive

Лучшие практики использования PowerShell c TeamCity

Sun, 12 May 2019 13:57:44 -0400

Данная статья является переводом. Оригинальная статья.

Правильная обработка ошибок

Наиболее распространенная проблема заключается в том, что TeamCity игнорирует ошибки Powershell, по крайней мере, в конфигурации по умолчанию. Если шаг со сценарием PowerShell завершится неудачно, TeamCity по-прежнему считает билд успешным. Это может привести к серьезным ошибкам, которые могут быть незаметны длительное время. Это происходит потому что значение настройки Format stderr output as установлено в warning. Для того чтобы TeamCity видел ошибки, необходимо переключить настройку в error.

Но это еще не все. Может возникнуть ситуация что шаг PowerShell упал но весь пайплайн признан успешным. Для этого нужно перейти в раздел Failure Conditions и установить флаг error message is logged by build runner.

Теперь все ошибки буду корректно обрабатываться и влиять на статус билда.

Также надо понимать модель ошибок в PowerShell. Они могут поделятся на 2 группы:

Завершающие (зачастую синтаксические ошибки).
Не завершающие.

Если возникло не завершающее исключение, то выполнение скрипта продолжится. Этот эффект может быть крайне нежелательным для сценариев, выполняющих взаимосвязанные операции, зависящие друг от друга. Конечно, мы можем изменить это поведение и превратить все «не завершающиеся» ошибки в «завершающиеся», установив переменную $ErrorActionPreference в начале наших скриптов:

#Error Action Preference:
#
# SilentlyContinue – error messages are suppressed and execution continues.
# Stop – forces execution to stop, behaving like a terminating error.
# Continue - the default option. Errors will display and execution will continue.
# Inquire – prompt the user for input to see if we should proceed.
# Ignore – (new in v3) – the error is ignored and not logged to the error stream. Has very restricted usage scenarios.

$ErrorActionPreference = "Stop"

Защита от случайных ошибок

Для начала необходимо превратить все наши функции в настоящие командлеты. Для этого нужно определять входящие параметры с помощью блока param() и пометить его атрибутом [CmdletBinding()]:

function Verb-Noun {
    [CmdletBinding()]
    param (
     #parameters go here   
    )    
}

Этот атрибут защищает вызов метода с не определенными параметрами. Каждый раз как кто-то использует не определенный/удаленный параметр или делает ошибку в его названии, PowerShell выбросит ошибку. Если метод не помечен атрибутов, имена параметров не проверяются, что затрудняет обнаружение проблемы.

Также можно обнаружить потенциальные ошибки, вызванные нарушением лучших практик и правил кодирования, включив строгий режим. Чтобы сделать это, добавьте следующий код в начале вашего скрипта:

Set-StrictMode -Version Latest

Детальнее можно почитать тут.

Вообще советую использовать VS Core и плагином PowerShell. Он превращает вашу в IDE в аналог PowerShell ISE. Также этот плагин поставляется с PSScriptAnalyzer, что позволяет обнаруживать разные ошибки.

Использование скриптов

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

Всегда помните о чистом коде.

Ваши скрипты как и код вашего проекта должен лежать в системе контроля версий, покрыт тестами и пройти ревью. Здесь вы можете найти лучшие практики и стили кодирования для PowerShell. Для тестирования кода можете использовать — Pester.

Итог

Связка PowerShell и Teamcity позволяет создать действительно мощный CI/CD. Но без понимания базовых принципов и механизмов вы не достигните максимального профита. Настройки по умолчанию часто могут приводить к непредвиденным ошибкам.

Ссылки

Практики и стили кодирования для PowerShell скриптов.
((https://github.com/pester/Pester Pester — тест и мок фреймворк для PowerShell.)
PowerShell strict mode.

PowerShell: создание Credentials.

Thu, 04 Apr 2019 16:54:17 -0400

Для того чтобы работать с авторизацией пользователя в powershell существую следующие понятия:
String — простая строка, в ней можно сохранять пароль, но не желательно, так как она хранится в памяти в открытом виде.
System.Security.SecureString — выглядит как обычная строка, но она зашифрована. Она использует «обратимое» шифрование, так что мы в любой момент можем декодировать пароль.
System.Management.Automation.PSCredential — класс, который содержит в себе логин и зашифрованный пароль. Данный тип есть почти у каждой команды, которая поддерживает авторизацию.

Создание SecureString

# Чтение из консоли
$SecurePassword = Read-Host -Prompt "Enter password" -AsSecureString

# Чтение из переменной
$PlainPassword = "P@ssw0rd"
$SecurePassword = $PlainPassword | ConvertTo-SecureString -AsPlainText -Force

Создание PSCredentials

$UserName = "Domain\User"
$Credentials = New-Object System.Management.Automation.PSCredential `
     -ArgumentList $UserName, $SecurePassword

Получение пароля из PSCredentials

$PlainPassword = $Credentials.GetNetworkCredential().Password

Получение пароля из SecureString

Можно создать PSCredentials и получить из них пароль, но есть и другой способ:

$BSTR = `
    [System.Runtime.InteropServices.Marshal]::SecureStringToBSTR($SecurePassword)
$PlainPassword = [System.Runtime.InteropServices.Marshal]::PtrToStringAuto($BSTR)

Лучшие подходы

Старайтесь не спрашивать у пользователя пароль, а по максимуму используйте Windows authentication.
Никогда не держите пароли в чистом виде, только в SecureString или PSCredentials
Если вам нужно запросить учетные данные у пользователя, используйте командлет Get-Credential. Он использует стандартную функцию Windows для последовательного и безопасного получения пароля без сохранения его в памяти в виде открытого текста.