Organización de módulos de PowerShell para el desarrollo en SharePoint

En esta publicación comparto mi enfoque para organizar código PowerShell. Objetivos principales:

Minimizar la duplicación de código
Mantener la estructura simple
Hacer el código reutilizable
Garantizar la flexibilidad
Centrarse en el desarrollo en SharePoint

Si trabajas con SharePoint y usas Visual Studio Code para el desarrollo en PowerShell, échale un vistazo primero a esta publicación: VisualStudioCode – PowerShell stubs for SharePoint.

Conceptos de organización del código:

Dot-sourcing
Módulos

Dot-Sourcing:

Este concepto se basa en una llamada específica al script (la máscara es: . .\script.ps1). Debido a esa ejecución, todas las variables usadas en script.ps1 existirán en el contexto actual (desde donde llamas a script1.ps1). Ten en cuenta que, cuando el script se ejecuta de forma ordinaria, tiene la máscara: .\script.ps1. **Ejemplo:**Por ejemplo, tenemos el script:

$answer=42
write-output ultimate answer is $answer

Veamos cómo se ejecutará de forma ordinaria:

PS D:\temp> .\script.ps1
ultimate answer is 42

PS D:\temp> $answer

Y la ejecución como dot-sourced:

PS D:\temp> . .\script.ps1
ultimate answer is 42

PS D:\temp> $answer
42

Como puedes ver, tras la ejecución ordinaria, la variable interna $answer no existe en el contexto padre. En el dot sourcing sí. ## Módulos

Este concepto se basa en 2 entidades: el manifiesto del módulo y el módulo. El módulo contiene toda la lógica del script de PowerShell (como las funciones que quieres exportar). El manifiesto del módulo es un formato sencillo para describir ese módulo (qué funciones se exportarán, desde dónde, y así sucesivamente). Veamos un módulo en detalle. Por ejemplo, tengo mi módulo Web.psm1 en el repositorio powershell-sharepoint:

function Get-List-On-Web {
    Param(
        [Microsoft.SharePoint.SPWeb] $web,
        [string] $listUrl
    )

    return $web.GetList($web.Url + '/lists/' + $listUrl)
}

Como puedes ver, es una función típica. Este archivo Web.psm1 está ubicado en una carpeta separada llamada Web dentro de la carpeta utils. Así, la estructura es:

+---scenarios
\---utils
    \---Web
            Web.psd1
            Web.psm1

Cerca de Web.psm1 también se crea el archivo Web.psd1 (archivo de manifiesto). Comando para crear el archivo de manifiesto (descrito aquí = [link])

New-ModuleManifest -Path C:\ps-test\Test-Module\Test-Module.psd1 -PassThru

Veamos qué contiene el archivo de manifiesto:

#
# Module manifest for module 'Web'
#
# Generated by: administrator
#
# Generated on: 14.08.2019
#

@{

# Script module or binary module file associated with this manifest.
RootModule = '.\Web.psm1'

# Version number of this module.
ModuleVersion = '1.0'

# Supported PSEditions
# CompatiblePSEditions = @()

# ID used to uniquely identify this module
GUID = 'd187c4b7-7b8e-4285-a750-6e87477e6a33'

# Author of this module
Author = 'administrator'

# Company or vendor of this module
CompanyName = 'Unknown'

# Copyright statement for this module
Copyright = '(c) 2019 administrator. All rights reserved.'

# Description of the functionality provided by this module
# Description = ''

# Minimum version of the Windows PowerShell engine required by this module
# PowerShellVersion = ''

# Name of the Windows PowerShell host required by this module
# PowerShellHostName = ''

# Minimum version of the Windows PowerShell host required by this module
# PowerShellHostVersion = ''

# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# DotNetFrameworkVersion = ''

# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# CLRVersion = ''

# Processor architecture (None, X86, Amd64) required by this module
# ProcessorArchitecture = ''

# Modules that must be imported into the global environment prior to importing this module
# RequiredModules = @()

# Assemblies that must be loaded prior to importing this module
# RequiredAssemblies = @()

# Script files (.ps1) that are run in the caller's environment prior to importing this module.
# ScriptsToProcess = @()

# Type files (.ps1xml) to be loaded when importing this module
# TypesToProcess = @()

# Format files (.ps1xml) to be loaded when importing this module
# FormatsToProcess = @()

# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
# NestedModules = @()

# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
FunctionsToExport = @('Get-List-On-Web')

# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
CmdletsToExport = @()

# Variables to export from this module
VariablesToExport = '*'

# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
AliasesToExport = @()

# DSC resources to export from this module
# DscResourcesToExport = @()

# List of all modules packaged with this module
# ModuleList = @()

# List of all files packaged with this module
# FileList = @()

# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
PrivateData = @{

    PSData = @{

        # Tags applied to this module. These help with module discovery in online galleries.
        # Tags = @()

        # A URL to the license for this module.
        # LicenseUri = ''

        # A URL to the main website for this project.
        # ProjectUri = ''

        # A URL to an icon representing this module.
        # IconUri = ''

        # ReleaseNotes of this module
        # ReleaseNotes = ''

    } # End of PSData hashtable

} # End of PrivateData hashtable

# HelpInfo URI of this module
# HelpInfoURI = ''

# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
# DefaultCommandPrefix = ''

}

FunctionsToExport - un array con los nombres de las funciones que se exportarán del módulo
- Puedes usar el comodín * aquí, pero no se recomienda

El escenario básico que usa la función lógica desde un módulo externo se muestra abajo:

Add-PSSnapin Microsoft.Sharepoint.Powershell

.\Load-Module.ps1 Web

$siteUrl = http://bot-sp2016/
$webUrl = http://bot-sp2016/SalesManagement/
$list = Sale

$web = Get-SPWeb $webUrl
$list = Get-List-On-Web $web $list

LoadModule.ps1 es un script auxiliar para facilitar el uso de Import-Module desde 1 almacenamiento central de utilidades:


Param(
    [string] $moduleName
)

Import-Module $PSScriptRoot\..\utils\$moduleName -Force

Dot-Sourcing:

Disponible para colaboración por contrato