Leia os artigos anteriores:

• Introdução ao Power Shell – Módulo 1: Script
• Introdução ao Power Shell – Módulo 2: Funções

Install-Module Chewbacca-Says 'Hrrrghghh Graaannngg'

|Módulo| no mundo Posh é um conjunto de funcionalidades agrupadas em uma unidade que lhe convém. Agrupando uma boa quantia de scripts, assemblies, recursos e afins você consegue compartilhar e reutilizar seu código com muito mais facilidade que em muitas outras linguagens ou frameworks.

A principal função dos módulos é permitir modularização (Leia a frase anterior de novo caso deseje que seu QI baixe alguns pontos) e abstração de código Posh.

Para criar um módulo PS, basta salvar seu arquivo com a extensão “.psm1”.

Só?

Sim…

Fazendo isso, você ganha controle sobre escopo (público, privado, etc.) sobre as funções e variáveis que estão em seu código. E a partir daqui você pode importar o módulo utilizando o comando que está no topo desta página, fazendo de seu módulo um dos tijolos de uma grande solução.

Uma breve introdução aos módulos já foi feita no texto de apresentação do Powershell. Lembrando, eles se dividem em: Script Module. Binary Module. Module Manifest.

Seremos um pouco mais incisivos sobre o que compreende um Script Module, pois ele se encaixa em nossa POC. Transformaremos a função Export-PrintScreen num módulo e a importaremos em nossa solução de automação.

Falando um pouco mais sobre o que será nosso módulo e o que pode ser um módulo, normalmente nos preocupamos com as seguintes premissas:

1. Um módulo é um conjunto de código e/ou um conjunto de controladores para assemblies;
2. Tudo que o código acima necessite, tais como assemblies adicionais, arquivos de ajuda ou outros scripts;
3. Um manifesto que descreva o módulo;
4. Um diretório que contenha todo o que foi listado acima e está localizado em um local no qual o Posh pode encontrá-lo.

Note que, na verdade, nenhum dos item acima é obrigatório. Por exemplo, você pode desejar ter um script simples que foi armazenado como um .psm1 ou um manifesto que está utilizando como ferramenta de organização, ou você pode também ter um módulo que cria suas dependências dinamicamente, sem ter a necessidade de um diretório que as guarde.

Bom… Vamos lá.

O primeiro passo é externar o código de nossa função para um arquivo apartado e salvar este arquivo com a extensão “.psm1”. Vou usar o nome “Print-Screen.psm1” para nossa brincadeira.

  <#
    .SYNOPSIS
        Print Screen function
    .DESCRIPTION
        Simples Powershell function to capture the screen
    .PARAMETER sSavePath
        The directory in which you desire to save your file (will be verified using Test-Path)
    .PARAMETER sFileName
        Specifies the file name you desire
    .EXAMPLE
        Export-PrintScreen -sFileName "print.png"
    .EXAMPLE
        Export-PrintScreen -sSavePath $HOME -sFileName "print.png"
    .NOTES
        Author: Otto Gori
        Date:   03/2017    
    #>
    function Export-PrintScreen{
    param(
        [Parameter(
            Position=0
        )]
        [ValidateScript(
            {Test-Path $_ -PathType Container}
        )][string]$sSavePath = $HOME,

        [Parameter(
            Mandatory=$True, 
            Position=1,
            HelpMessage="Chose your file name"
        )][string]$sFileName

    )
        process{
            $infoMonitor =  [System.Windows.Forms.SystemInformation]::PrimaryMonitorSize

            $comBounds = [Drawing.Rectangle]::FromLTRB(0, 0, $infoMonitor.Width, $infoMonitor.Height)

            $bmpImage = New-Object Drawing.Bitmap $comBounds.width, $comBounds.height

            $comGraphics = [Drawing.Graphics]::FromImage($bmpImage)

            $comGraphics.CopyFromScreen($comBounds.Location, [Drawing.Point]::Empty, $comBounds.size)

            $bmpImage.Save($sSavePath+'\'+$sFileName)

            $comGraphics.Dispose()
            $bmpImage.Dispose()
        
        }
    }

Como esse módulo só tem uma função, ela poderia estar exposta. Entretanto, por padrão, expomos exatamente os pontos que desejamos no final do código.

Export-ModuleMember -function Export-PrintScreen

Você também pode restringir os acessos usando manifestos. Se houver alguma dependência nesse módulo, ela deve ser declarada no início com uma linha semelhante à que temos no topo desta página:

Import-Module Lord-Vader -MinimumVersion ‘RogueOne’, por fim, se ainda houver alguma dependência (Ex: Arquivo XML), ela também pode ser controlada usando um manifesto.

Para usarmos o módulo, devemos posicioná-lo em um dos caminhos default que o PS pode ver. Você pode obter um desses valores com este comando: $env:PSModulePath. Por convenção podemos usar: %SystemRoot%\users\<user>\Documents\WindowsPowerShell\Modules\<moduleName>.

Agora basta importarmos o módulo com o comando: Import-Module Print-Screen no início de nosso código original e usar sua função normalmente.

Você também pode fazer isso por meio de dotSourcing .\Print-Screen, mas essa não é uma boa opção quando se pensa em escalabilidade ou usabilidade. Afinal, se o módulo não estiver no exato diretório que esperava, isso não vai funcionar.

Com o módulo importado, basta chamar suas funções normalmente como se fossem nativas ao sistema. Existem situações em que você tem dois módulos, de terceiros, com funções de mesmo nome. Para mitigar isso costumamos “Tipar” a chamada com o nome do módulo que deseja usar. No nosso caso fica Print-Screen\Export-PrintScreen -sSavePath $HOME -sFileName “print.png” ou seja, isso é um “From\Call [-Args-]”

Lembre-se de sempre remover o módulo ao final de seu uso para não deixar sujeira na memória. Aposto que a essa altura você já sabe o comando…

E é isso! Ficou alguma dúvida ou tem alguma sugestão? Aproveite os campos abaixo. Até a próxima!