PsKrane.psm1
|
Enum ProjectType { Module Script } Enum ItemFileType{ Class PublicFunction PrivateFunction } Enum KraneTemplateType{ Class Function Script Test } Class KraneFile { <# .SYNOPSIS Represents a KraneFile .DESCRIPTION Represents the .Krane.Json file that is used to store the configuration of the Krane Project #> #region properties [System.IO.FileInfo]$Path [System.Collections.Hashtable]$Data = @{} [Bool]$IsPresent #endregion #region constructors <# .SYNOPSIS Base constructor .PARAMETER Path A string that represents the the path of the krane file. It should point to the .Krane.Json file. If not, it will assume that it is pointing to the folder that contains the .krane.json file. #> KraneFile([String]$Path) { Write-Debug "[KraneFile][KraneFile([String])] Start" #Handeling case when Path doesn't exists yet (For creation scenarios) $Root = "" if ((Test-Path -Path $Path) -eq $False) { if ($Path.EndsWith(".krane.json")) { [System.Io.DirectoryInfo]$Root = ([System.Io.FileInfo]$Path).Directory } else { [System.Io.DirectoryInfo]$Root = $Path } } else { #Path exists. We need to determine if it is a file or a folder. $Item = Get-Item -Path $Path if ($Item.PSIsContainer) { $Root = $Item } else { $Root = $Item.Directory } } $this.Path = Join-Path -Path $Root.FullName -ChildPath ".krane.json" $this.IsPresent = $this.Path.Exists if (!$this.Path.Exists) { Write-Debug "[KraneFile][KraneFile([String])] .Krane.Json file not found at expected path '$($This.Path)'!" #Krane file doesn't exists. No point in importing data from a file that doesn't exists. $this.Data = @{} return } Write-Debug "[KraneFile][KraneFile([String])] .Krane.Json file found. Importing data from '$($This.Path)'" $Raw = Get-Content -Path $This.Path.FullName -Raw | ConvertFrom-Json #Convert the JSON to a hashtable as it is easier to manipulate. foreach ($key in $Raw.PsObject.Properties) { $this.Data.$($key.Name) = $key.Value } Write-Debug "[KraneFile][KraneFile([String])] End" } #endregion #region Methods <# .SYNOPSIS Retrieves a specific value from the krane.json file .PARAMETER Key The key to retrieve. #> [String]Get([String]$Key) { Write-Debug "[KraneFile][Get([String])] getting value of '$($Key)'" return $this.Data.$Key } <# .SYNOPSIS Sets a value into the .krane.json file. .PARAMETER Key The key where to set the value .PARAMETER Value The value to set. #> [Void]Set([String]$Key, [String]$Value) { Write-Debug "[KraneFile][Set([String],[String])] Key -> '$key' -> '$value' " $this.Data.$Key = $Value } <# .SYNOPSIS Persist the change to the .krane.json file #> [Void]Save() { Write-Debug "[KraneFile][Save()] Start" if (!($this.Path.Exists)) { $Null = [System.Io.Directory]::CreateDirectory($this.Path.Directory.FullName) | Out-Null } $this.Data | ConvertTo-Json | Out-File -FilePath $this.Path.FullName -Encoding utf8 -Force $this.Path.Refresh() $this.IsPresent = $this.File.Exists Write-Debug "[KraneFile][Save()] File saved to '$($this.Path.FullName)'" } <# .SYNOPSIS Fetch the data of the existing .krane.json file #> [void]Fetch() { Write-Debug "[KraneFile][Fetch()] Start" $Raw = Get-Content -Path $This.Path.FullName -Raw | ConvertFrom-Json #Convert the JSON to a hashtable as it is easier to manipulate. foreach ($key in $Raw.PsObject.Properties) { $this.Data.$($key.Name) = $key.Value } $this.Path.Refresh() $this.IsPresent = $this.Path.Exists Write-Debug "[KraneFile][Fetch()] End" } <# .SYNOPSIS Default ToString() overload. #> [String]ToString() { $Message = "ProjectName:{0} ProjectType:{1}" -f $this.Get("Name"), $this.Get("ProjectType") Write-Debug "[KraneFile][ToString()] $($Message) " return $Message } <# .SYNOPSIS Static method to create a .krane.json file .PARAMETER Path The path where the .krane.json file should be created. .PARAMETER Name The name of the project .PARAMETER Type The type of the project #> static [KraneFile] Create([System.IO.DirectoryInfo]$Path, [String]$Name, [ProjectType]$Type) { Write-Debug "[KraneFile][Create] Start" $KraneFile = [KraneFile]::New($Path) if ($KraneFile.Path.Exists) { Throw ".Krane File $($KraneFile.Path.FullName) already exists" } $KraneFile.Set("Name", $Name) $KraneFile.Set("ProjectType", $Type) $KraneFile.Set("ProjectVersion", "0.0.1") $KraneFile.Save() Write-Debug "[KraneFile][Create] End" Return $KraneFile } #endregion } Class KraneProject { <# .SYNOPSIS Represents a Krane Project .DESCRIPTION Represents a Krane Project. The project can be a module, a script, etc. #> #region Properties [System.IO.DirectoryInfo]$Root [KraneFile]$KraneFile [ProjectType]$ProjectType [String]$ProjectVersion [KraneTemplateCollection]$Templates #endregion #region Constructors <# .SYNOPSIS Base constructor #> KraneProject() { } <# .SYNOPSIS Constructor .PARAMETER Root The root folder of the project #> KraneProject([System.IO.DirectoryInfo]$Root) { Write-Debug "[KraneProject][Constructor([System.IO.DirectoryInfo])] Start" $this.Root = $Root $this.Build = "$($Root.FullName)\Build" $this.Sources = "$($Root.FullName)\Sources" $this.Tests = "$($Root.FullName)\Tests" $this.Outputs = "$($Root.FullName)\Outputs" $this.KraneFile = [KraneFile]::New($Root) $this.ProjectVersion = $this.KraneFile.Get("ProjectVersion") $this.Templates = [KraneTemplateCollection]::New($this) Write-Debug "[KraneProject][Constructor([System.IO.DirectoryInfo])] End" } #endregion #region Methods <# .SYNOPSIS Add an item to the project. The item can be a script, a module, a test, etc. .DESCRIPTION This method is intended to be overwritten in a child class. #> AddItem([String]$Name, [String]$Type) { throw "Must be overwritten!" } <# .SYNOPSIS Loads the templates #> [void] LoadTemplates(){ Write-Debug "[KraneProject][LoadTemplates()] Start" $this.Templates = [KraneTemplateCollection]::New($this) Write-Debug "[KraneProject][LoadTemplates()] End" } <# .SYNOPSIS Get the 'Tests' folder of the project for convenience. #> [System.Io.DirectoryInfo] GetTestsFolderPath() { return Join-Path -Path $this.Root.FullName -ChildPath "Tests" } <# .SYNOPSIS Get the 'sources' folder of the project for convenience. #> [System.Io.DirectoryInfo] GetSourcesFolderPath() { return Join-Path -Path $this.Root.FullName -ChildPath "Sources" } <# .SYNOPSIS Get the 'Outputs' folder of the project for convenience. #> [System.Io.DirectoryInfo] GetOutputsFolderPath() { return Join-Path -Path $this.Root.FullName -ChildPath "Outputs" } <# .SYNOPSIS Get the 'Build' folder of the project for convenience. #> [System.Io.DirectoryInfo] GetBuildFolderPath() { return Join-Path -Path $this.Root.FullName -ChildPath "Outputs" } <# .SYNOPSIS Gets the project name from the .krane.json file. #> [string] GetProjectName(){ $ProjectName = $this.KraneFile.Get("Name") Write-Debug "[KraneProject][GetProjectName()] Project Name -> $($ProjectName)" return $ProjectName } #endregion } Class KraneModule : KraneProject { <# .SYNOPSIS Represents a Krane Module .DESCRIPTION Represents a Krane Module. The KraneModule is nothing else then a PowerShell module with a set of codified conventions around it. #> #region properties [String]$ModuleName hidden [System.IO.FileInfo]$ModuleFile hidden [System.IO.FileInfo]$ModuleDataFile hidden [System.IO.DirectoryInfo]$Build hidden [System.IO.DirectoryInfo]$Sources hidden [System.IO.DirectoryInfo]$Tests hidden [System.IO.DirectoryInfo]$Outputs [String[]] $Tags = @( 'PSEdition_Core', 'PSEdition_Desktop' ) [String]$Description [String]$ProjectUri [Bool]$IsGitInitialized [PsModule]$PsModule [TestHelper]$TestData Hidden [System.Collections.Hashtable]$ModuleData = @{} #endregion #region Constructors <# .SYNOPSIS Constructor .DESCRIPTION This constructor calls the parent constructor first. .PARAMETER Root The root folder of the project. #> KraneModule([System.IO.DirectoryInfo]$Root) : base([System.IO.DirectoryInfo]$Root) { #When the module Name is Not passed, we assume that a .Krane.json file is already present at the root. Write-Debug "[KraneModule][Constructor([System.IO.DirectoryInfo]Root)] Start" Write-Debug "[KraneModule][Constructor([System.IO.DirectoryInfo]Root)] Creating module from root -> $($Root.FullName)" $this.ProjectType = [ProjectType]::Module #$this.LoadTemplates() #get the module name from the krane file $this.TestData = [PesterTestHelper]::New($this.Tests) $mName = $this.KraneFile.Get("Name") $this.SetModuleName($mName) $this.ProjectType = $this.KraneFile.Get("ProjectType") $this.FetchModuleInfo() $this.FetchGitInitStatus() Write-Debug "[KraneModule][Constructor([System.IO.DirectoryInfo]Root)] End" } <# .SYNOPSIS Constructor .DESCRIPTION When the module Name is passed, we assume that the module is being created, and that there is not a .Krane.json file present. yet. .PARAMETER Root The root folder of the project. .PARAMETER ModuleName The name of the module #> KraneModule([System.IO.DirectoryInfo]$Root, [String]$ModuleName) { #When the module Name is passed, we assume that the module is being created, and that there is not a .Krane.json file present. yet. Write-Debug "[KraneModule][Constructor([System.IO.DirectoryInfo],[String])] Start" $Root = Join-Path -Path $Root -ChildPath $ModuleName $This.KraneFile = [KraneFile]::Create($Root, $ModuleName, [ProjectType]::Module) $this.ProjectType = [ProjectType]::Module $this.Root = $Root $this.Build = "$Root\Build" $this.Sources = "$Root\Sources" $this.Tests = "$Root\Tests" $this.Outputs = "$Root\Outputs" $this.ModuleName = $ModuleName $this.ProjectVersion = $this.GetProjectVersion() $this.LoadTemplates() $this.FetchModuleInfo() $this.FetchGitInitStatus() Write-Debug "[KraneModule][Constructor([System.IO.DirectoryInfo],[String])] End" } #endregion #region methods <# .SYNOPSIS Fetches the module information from the module data file. .DESCRIPTION This method will fetch the module information from the module data file. If the module data file doesn't exists, it will create one. #> hidden [void] FetchModuleInfo() { Write-Debug "[KraneModule][FetchModuleInfo] Start" if (($null -eq $this.ModuleName)) { Throw "Module Name not provided." } $this.SetModuleName($this.ModuleName) if ($this.ModuleDataFile.Exists) { $this.ModuleData = Import-PowerShellDataFile -Path $this.ModuleDataFile.FullName $this.Description = $this.ModuleData.Description $this.ProjectUri = $this.ModuleData.PrivateData.PsData.ProjectUri $this.Tags = $this.ModuleData.PrivateData.PsData.Tags } $this.PsModule = [PsModule]::New($this.ModuleFile.FullName) Write-Debug "[KraneModule][FetchModuleInfo] End" } <# .SYNOPSIS Builds the module. #> [void] BuildModule() { Write-Debug "[KraneModule][BuildModule] Start" Write-Debug "[KraneModule][BuildModule][PSM1] Starting PSM1 Operations $($this.ModuleName)" if ($this.ModuleFile.Exists) { Write-Debug "[KraneModule][BuildModule][PSM1] Module file already exists. Deleting." $this.ModuleFile.Delete() $this.ModuleFile.Refresh() } Write-Debug "[KraneModule][BuildModule][PSM1] (Re)creating file $($this.ModuleFile.FullName)" $Null = New-Item -Path $this.ModuleFile.FullName -ItemType "file" -Force $MainPSM1Contents = @() Write-Debug "[KraneModule][BuildModule][PSM1] Searching for classes and functions" [System.IO.FileInfo]$PreContentPath = Join-Path -Path $this.Sources.FullName -ChildPath "PreContent.ps1" If ($PrecontentPath.Exists) { Write-Verbose "[KraneModule][BuildModule][PSM1] Precontent.ps1 file found. Adding to module file." $MainPSM1Contents += $PreContentPath } else { Write-Debug "[KraneModule][BuildModule][PSM1] No Precontent detected." } [System.IO.DirectoryInfo]$ClassFolderPath = Join-Path -Path $this.Sources.FullName -ChildPath "Classes" If ($ClassFolderPath.Exists) { $PublicClasses = Get-ChildItem -Path $ClassFolderPath.FullName -Filter *.ps1 | sort-object Name if ($PublicClasses) { Write-Debug "[KraneModule][BuildModule][PSM1] Classes Found. Importing..." $MainPSM1Contents += $PublicClasses } } [System.IO.DirectoryInfo]$PrivateFunctionsFolderPath = Join-Path -Path $this.Sources.FullName -ChildPath "Functions/Private" If ($PrivateFunctionsFolderPath.Exists) { $Privatefunctions = Get-ChildItem -Path $PrivateFunctionsFolderPath.FullName -Filter *.ps1 | sort-object Name if ($Privatefunctions) { Write-Debug "[KraneModule][BuildModule][PSM1] Private functions Found. Importing..." $MainPSM1Contents += $Privatefunctions } } $Publicfunctions = $null [System.IO.DirectoryInfo]$PublicFunctionsFolderPath = Join-Path -Path $this.Sources.FullName -ChildPath "Functions/Public" If ($PublicFunctionsFolderPath.Exists) { $Publicfunctions = Get-ChildItem -Path $PublicFunctionsFolderPath.FullName -Filter *.ps1 | sort-object Name if ($Publicfunctions) { Write-Debug "[KraneModule][BuildModule][PSM1] Public functions Found. Importing..." $MainPSM1Contents += $Publicfunctions } } [System.IO.FileInfo]$PostContentPath = Join-Path -Path $this.Sources.FullName -ChildPath "postContent.ps1" If ($PostContentPath.Exists) { Write-Debug "[KraneModule][BuildModule][PSM1] Postcontent found. Importing..." $MainPSM1Contents += $PostContentPath } #Creating PSM1 Write-Debug "[KraneModule][BuildModule][PSM1] Building PSM1 content" Foreach ($file in $MainPSM1Contents) { Write-Debug "[KraneModule][BuildModule][PSM1] Adding -> $($File.FullName)" Get-Content $File.FullName | out-File -FilePath $this.ModuleFile.FullName -Encoding utf8 -Append } Write-Debug "[KraneModule][BuildModule][PSD1] Starding PSD1 actions. Adding functions to export" if (!$this.ModuleDataFile.Exists) { Write-Debug "[KraneModule][BuildModule][PSD1] Module Manifest not found. Creating one." New-ModuleManifest -Path $this.ModuleDataFile.FullName } $ManifestParams = @{} $ManifestParams.Path = $this.ModuleDataFile.FullName $ManifestParams.FunctionsToExport = $Publicfunctions.BaseName if($this.Tags) { $ManifestParams.Tags = $This.Tags } $ManifestParams.RootModule = $this.ModuleFile.Name if($this.ProjectUri) { $ManifestParams.ProjectUri = $this.ProjectUri } if($this.Description) { $ManifestParams.Description = $this.Description } $ManifestParams.ModuleVersion = $this.ProjectVersion Write-Debug "[KraneModule][BuildModule][PSD1] Writing Manifest settings:" foreach ($ManifestSetting in $ManifestParams.GetEnumerator()) { Write-Debug "[KraneModule][BuildModule][PSD1][Setting] $($ManifestSetting.Key) -> $($ManifestSetting.Value)" } try { Update-ModuleManifest @ManifestParams } Catch { Write-Error "[KraneModule][BuildModule][PSD1] Error updating module manifest. $_" } Write-Debug "[KraneModule][BuildModule] End" } <# .SYNOPSIS Sets the module name and updates the module file and module data file paths. .DESCRIPTION This method will set the module name and update the module file and module data file paths. .PARAMETER ModuleName The name of the module #> [void] SetModuleName([String]$ModuleName) { Write-Debug "[KraneModule][SetModuleName([string])] Start" $this.ModuleName = $ModuleName $this.ModuleFile = Join-Path -Path $this.Outputs.FullName -ChildPath "Module\$($ModuleName).psm1" $this.ModuleDataFile = Join-Path -Path $this.Outputs.FullName -ChildPath "Module\$($ModuleName).psd1" Write-Debug "[KraneModule][SetModuleName([End])]" } <# .SYNOPSIS Creates the base structure of the KraneModule #> [void] CreateBaseStructure() { Write-Debug "[KraneModule][CreateBaseStructure()] Start" if ($this.Outputs.Exists -eq $false) { Write-Debug "[KraneModule][CreateBaseStructure()] Creating 'Outputs' folder $($this.Outputs.FullName)" $Null = New-Item -Path $this.Outputs.FullName -ItemType "directory" } $ModuleFolderPath = Join-Path -Path $this.Outputs.FullName -ChildPath "Module" if (-not (Test-Path -Path $ModuleFolderPath)) { Write-Debug "[KraneModule][CreateBaseStructure()] Creating 'Module' folder $($ModuleFolderPath)" $Null = New-Item -Path $ModuleFolderPath -ItemType "directory" } #Creating Base psm1 and psd1 files $Psm1File = Join-Path -Path $ModuleFolderPath -ChildPath "$($this.ModuleName).psm1" $Psd1File = Join-Path -Path $ModuleFolderPath -ChildPath "$($this.ModuleName).psd1" Write-Debug "[KraneModule][CreateBaseStructure()] Creating 'Module Manifest' at '$($Psd1File)'" New-ModuleManifest -Path $Psd1File -RootModule $($this.ModuleName).psm1 -Description "Created with love using PsKrane" -ProjectUri "https://github.com/Stephanevg/PsKrane" if (-not (Test-Path -Path $Psm1File)) { Write-Debug "[KraneModule][CreateBaseStructure()] Creating 'Module' file at '$($Psm1File)'" $Null = New-Item -Path $Psm1File -ItemType "file" } if ($this.Build.Exists -eq $false) { Write-Debug "[KraneModule][CreateBaseStructure()] Creating 'Build' folder at '$($this.Build.FullName)'" $Null = New-Item -Path $this.Build.FullName -ItemType "directory" } if ($this.Sources.Exists -eq $false) { Write-Debug "[KraneModule][CreateBaseStructure()] Creating 'Sources' folder at '$($this.Build.FullName)'" $Null = New-Item -Path $this.Sources.FullName -ItemType "directory" } $ClassesPath = Join-Path -Path $this.Sources.FullName -ChildPath "Classes" if (-not (Test-Path -Path $ClassesPath )) { Write-Debug "[KraneModule][CreateBaseStructure()] Creating 'Classes' folder at '$($ClassesPath)'" $Null = New-Item -Path $ClassesPath -ItemType "directory" } [System.IO.DirectoryInfo] $PrivateFunctions = Join-Path -Path $this.Sources.FullName -ChildPath "Functions/Private" if ($PrivateFunctions.Exists -eq $false) { Write-Debug "[KraneModule][CreateBaseStructure()] Creating 'Private function' folder at '$($PrivateFunctions.FullName)'" $Null = New-Item -Path $PrivateFunctions.FullName -ItemType "directory" } [System.IO.DirectoryInfo] $PublicFunctions = Join-Path -Path $this.Sources.FullName -ChildPath "Functions/Public" if ($PublicFunctions.Exists -eq $false) { Write-Debug "[KraneModule][CreateBaseStructure()] Creating 'Public function' folder at '$($PublicFunctions.FullName)'" $Null = New-Item -Path $PublicFunctions.FullName -ItemType "directory" } if ($this.Tests.Exists -eq $false) { Write-Debug "[KraneModule][CreateBaseStructure()] Creating 'Tests' folder at '$($this.Tests.FullName)'" $Null = New-Item -Path $this.Tests.FullName -ItemType "directory" } Write-Debug "[KraneModule][CreateBaseStructure()] End" } <# .SYNOPSIS ReverseBuild will take the module file and extract the content to the sources folder. .PARAMETER Force If set to true, the method will overwrite the existing files. #> [void]ReverseBuild([bool]$Force) { Write-Debug "[KraneModule][ReverseBuild([bool]Force)] Start" $this.PsModule.ReverseBuild($Force) Write-Debug "[KraneModule][ReverseBuild([bool]Force)] End" } <# .SYNOPSIS ReverseBuild will take the module file and extract the content to the sources folder. .PARAMETER Name The name of the item to reverse build. (function / class names) .PARAMETER Force If set to true, the method will overwrite the existing item. #> [void]ReverseBuild([string]$Name,[bool]$Force) { #ReverseBuild will take the module file and extract the content to the sources folder. Write-Debug "[KraneModule][ReverseBuild([string]Name,[bool]Force)] Start" $this.PsModule.ReverseBuild($Name,$Force) Write-Debug "[KraneModule][ReverseBuild([string]Name,[bool]Force)] End" } <# .SYNOPSIS Get the project vesrsion from the Kranefile. #> [string]GetProjectVersion() { $ProjectVersion = $this.KraneFile.Get("ProjectVersion") Write-Debug "[KraneModule][GetProjectVersion()] Project Version -> '$ProjectVersion)'" return $ProjectVersion } <# .SYNOPSIS Sets the project version in ALL the locations: - .krane.json file - .psd1 file - ProjectVersion property .Description Note: The nuspec will get the value from the property when it gets created. .PARAMETER Version The version that should be set. #> [void]SetProjectVersion([string]$Version) { Write-Debug "[KraneModule][SetProjectVersion(string[])] Start" Write-Debug "[KraneModule][SetProjectVersion(string[])] Setting ProjectVersion -> '$Version)'" $this.ProjectVersion = $Version $this.KraneFile.Set("ProjectVersion", $Version) $this.KraneFile.Save() Update-ModuleManifest -Path $this.ModuleDataFile.FullName -ModuleVersion $Version Write-Debug "[KraneModule][SetProjectVersion(string[])] End" } <# .SYNOPSIS Fetches the git initialization status of the project. #> [Void] FetchGitInitStatus() { Write-Debug "[KraneModule][FetchGitInitStatus()] Start" [System.IO.DirectoryInfo]$GitFolderpath = join-Path -Path $this.Root.FullName -ChildPath ".git\" $this.IsGitInitialized = $GitFolderpath.Exists Write-Debug "[KraneModule][FetchGitInitStatus()] $($this.IsGitInitialized)" Write-Debug "[KraneModule][FetchGitInitStatus()] End" } <# .SYNOPSIS Adds an item to the KraneProject. The item can be a script, a module, a test, etc. .DESCRIPTION This method will add an KraneItem (File + reference in the KraneModule somewhere) to the project. .PARAMETER Name The name of the item to add. .PARAMETER Type The type of the item to add (which is of type [ItemFileType]) #> [void] AddItem([String]$Name, [ItemFileType]$Type) { #Add an item to the project. The item can be a script, a module, a test, etc. #Logic is delegated to internal private methods. switch ($Type) { "Class" { $this.AddClass($Name) } "PublicFunction" { $this.AddPublicFunction($Name) } "PrivateFunction" { $this.AddPrivateFunction($Name) } "Test" { $this.AddTest($Name) } default { Throw "Type $Type not supported" } } } <# .SYNOPSIS Adds a new class .PARAMETER Name The name of the class to add. .PARAMETER Content The content that the class will have #> hidden AddClass([String]$Name, [String]$Content) { Write-Debug "[KraneModule][AddClass([String],[String])][$($Name)] Start" $ClassRootFolder = Join-Path -Path $this.Sources.FullName -ChildPath "Classes" [System.IO.FileInfo] $ClassPath = Join-Path -Path $ClassRootFolder -ChildPath "$Name.ps1" if ($ClassPath.Exists) { throw "Class '$Name' file already exists at '$($ClassPath.FullName)'" } $ClassExists = $this.PsModule.GetClasses() | Where-Object -Filter {$_.Name -eq $Name} if($ClassExists){ throw "Class '$Name' already exists Please remove it from the psm1 or rename it and try again!" } Write-Debug "[KraneModule][AddClass([String],[String])] Creating file $($ClassPath.FullName)" $Null = New-Item -Path $ClassPath.FullName -ItemType "file" -Value $Content -Force $ClassPath.Refresh() $this.PsModule.GetAstClasses($ClassPath.FullName) Write-Debug "[KraneModule][AddClass([String],[String])] End" } <# .SYNOPSIS Adds a new public function .PARAMETER Name The name of the function to add. .PARAMETER Content The content that the function will have #> hidden AddPublicFunction([String]$Name, [String]$Content) { Write-Debug "[KraneModule][AddPublicFunction([String],[String])][$($Name)] Start" [System.IO.FileInfo] $FunctionPath = Join-Path -Path $this.Sources.FullName -ChildPath "Functions\Public\$Name.ps1" if ($FunctionPath.Exists) { Throw "Function '$Name' file already exists at '$($FunctionPath.FullName)'. Remove the file and try again!" } #Validating that the function is not already existing. $FunctionExists = $this.PsModule.GetPublicFunctions() | Where-Object -Filter {$_.Name -eq $Name} if($FunctionExists){ Throw "Function '$Name' file already exists! Please remove the function from the psm1, or use another name!" } Write-Debug "[KraneModule][AddPublicFunction([String],[String])][$($Name)] Creating file at '$($FunctionPath.FullName)'" $Null = New-Item -Path $FunctionPath.FullName -ItemType "file" -Value $Content $BaseName = $Name.Replace(".ps1","") if (-not ($this.ModuleData.FunctionsToExport -contains $BaseName)) { $this.ModuleData.FunctionsToExport += $BaseName Write-Debug "[KraneModule][AddPublicFunction([String],[String])][$($Name)] Updating module manifest" Update-ModuleManifest -Path $this.ModuleDataFile.FullName -FunctionsToExport $this.ModuleData.FunctionsToExport $this.ModuleDataFile.Refresh() } Write-Debug "[KraneModule][AddPublicFunction([String],[String])][$($Name)] Updating function state" $this.PsModule.GetASTFunctions($FunctionPath) Write-Debug "[KraneModule][AddPublicFunction([String],[String])][$($Name)] End" } <# .SYNOPSIS Adds a new private function .PARAMETER Name The name of the function to add. .PARAMETER Content The content that the function will have #> hidden AddPrivateFunction([String]$Name, [String]$Content) { Write-Debug "[KraneModule][AddPublicFunction([String],[String])][$($Name)] Start" [System.IO.FileInfo]$FunctionPath = Join-Path -Path $this.Sources.FullName -ChildPath "Functions\Private\$Name.ps1" if ($FunctionPath.Exists) { Throw "Function $Name already exists" } #Validating that the function is not already existing. $FunctionExists = $this.PsModule.GetPrivateFunctions() | Where-Object -Filter {$_.Name -eq $Name} if($FunctionExists){ Throw "Function '$Name' file already exists! Please remove the function from the psm1, or use another name!" } Write-Debug "[KraneModule][AddPublicFunction([String],[String])][$($Name)] Creating file at '$($FunctionPath.FullName)'" $Null = New-Item -Path $FunctionPath.FullName -ItemType "file" -Value $Content Write-Debug "[KraneModule][AddPublicFunction([String],[String])][$($Name)] Updating function state" $this.PsModule.GetASTFunctions($FunctionPath) Write-Debug "[KraneModule][AddPublicFunction([String],[String])][$($Name)] End" } <# .SYNOPSIS Returning all existing Templates #> [KraneTemplate[]] GetTemplates() { Write-Debug "[KraneModule][GetTemplates()] Fetching all Templates" return $this.Templates.GetTemplates() } <# .SYNOPSIS Get a template by type .PARAMETER TemplateType The type of the template to retrieve #> [KraneTemplate] GetTemplate([KraneTemplateType]$TemplateType) { #TODO Should we allow to return $null ? Write-Debug "[KraneModule][GetTemplate([KraneTemplateType])] Start" $Template = $this.Templates | Where-Object { $_.Type -eq $TemplateType } if ($null -eq $Template) { Throw "Template '$TemplateType' not found" } Write-Debug "[KraneModule][GetTemplate([KraneTemplateType])] End" Return $Template } <# .SYNOPSIS Get a template by type and location .PARAMETER Type The type of the template to retrieve .PARAMETER Location The location of the template to retrieve #> [KraneTemplate[]] GetTemplate([String]$Type, [LocationType]$Location) { #TODO allow to return $null or throw? Write-Debug "[KraneModule][GetTemplate([String],[LocationType])] Start" $Template = $this.Templates.GetTemplate($Type, $Location) if ($null -eq $Template) { Throw "Template '$Type' of location type '$Location' not found" } Write-Debug "[KraneModule][GetTemplate([String],[LocationType])] End" Return $Template } <# .SYNOPSIS Get a template by location .PARAMETER Location The location of the template to retrieve #> [KraneTemplate[]] GetTemplate([LocationType]$Location) { Write-Debug "[KraneModule][GetTemplate([LocationType])] Start" $Template = $this.Templates.GetTemplate($Location) Write-Debug "[KraneModule][GetTemplate([LocationType])] End" Return $Template } <# .SYNOPSIS Reloads all the project information #> [Void] ReloadAll(){ Write-Debug "[KraneModule][ReloadAll()] Start" $this.ProjectVersion = $this.GetProjectVersion() $this.LoadTemplates() $this.FetchModuleInfo() $this.FetchGitInitStatus() Write-Debug "[KraneModule][ReloadAll()] End" } <# .SYNOPSIS Sets the description of the module .PARAMETER Description The description of the module #> [Void]SetDescription([string]$Description){ Write-Debug "[KraneModule][SetDescription([string])] Setting Description '$Description'" $this.Description = $Description } <# .SYNOPSIS Retrieve the BuildFile path #> [system.IO.FileInfo] GetBuildFile(){ Write-Debug "[KraneModule][GetBuildFile()] Start" [System.IO.FileInfo] $BuildFile = Join-Path -Path $this.Build.FullName -ChildPath "Build.Krane.ps1" Write-Debug "[KraneModule][GetBuildFile()] BuildFile -> '$($BuildFile.FullName)' Exists -> $($BuildFile.Exists)" Write-Debug "[KraneModule][GetBuildFile()] End" return $BuildFile } #endregion } Class ModuleObfuscator { [String]$ModuleName [KraneModule]$Module [System.IO.DirectoryInfo]$Bin [System.IO.FileInfo]$BinaryModuleFile [System.IO.FileInfo]$ModuleDataFile Obfuscator() {} SetKraneModule([KraneModule]$Module) { $Module.ModuleDataFile.Refresh() if (!$Module.ModuleDataFile.Exists) { Write-Verbose "[BUILD][OBFUSCATE] Module data file Not found. Building module" $this.Module.BuildModule() } $this.Module = $Module $this.Bin = $Module.Outputs.FullName + "\Bin" $this.BinaryModuleFile = Join-Path -Path $this.Bin.FullName -ChildPath ($this.Module.ModuleFile.BaseName + ".dll") $this.ModuleDataFile = $this.Bin.FullName + "\" + $this.Module.ModuleName + ".psd1" } Obfuscate() { Write-Verbose "[BUILD][OBFUSCATE] Obfuscating module" Write-Verbose "[BUILD][OBFUSCATE] Starting psd1 operations" if (!$this.ModuleDataFile.Exists) { $this.Module.ModuleDataFile.CopyTo($this.ModuleDataFile.FullName) $this.ModuleDataFile.Refresh() } #Does seem to work. #Update-ModuleManifest -Path $this.ModuleDataFile.FullName -RootModule $this.BinaryModuleFile.Name $MdfContent = Get-Content -Path $this.ModuleDataFile.FullName $MdfContent.Replace($this.Module.ModuleFile.Name, $this.BinaryModuleFile.Name) | Set-Content -Path $this.ModuleDataFile.FullName #We obfuscate #Create the DLL in the Artifacts folder } } Class KraneFactory { <# .SYNOPSIS This class helps to create the right KraneProject. #> #region properties #endregion #region constructors #endregion #region Methods <# .SYNOPSIS returns the right project based on the KraneFile. .PARAMETER KraneFile The path to the KraneFile that will be used to determine the project type. #> static [KraneProject]GetProject([System.IO.FileInfo]$KraneFile) { Write-Debug "[KraneFactory][GetProject([System.IO.FileInfo])] Start" Write-Debug "[KraneFactory][GetProject([System.IO.FileInfo])] Gathering information from kranefile at $($KraneFile.FullName)" $KraneDocument = [KraneFile]::New($KraneFile) $ProjectType = $KraneDocument.Get("ProjectType") $Root = $KraneFile.Directory Write-Debug "[KraneFactory][GetProject([System.IO.FileInfo])] Project is of type -> '$ProjectType'" switch ($ProjectType) { "Module" { Write-Debug "[KraneFactory][GetProject([System.IO.FileInfo])] Building KraneModule project from '$($Root.FullName)'" $KM = [KraneModule]::New($Root) #$KM.ProjectVersion = $KraneDocument.Get("ProjectVersion") #The version is not handled in the creation process of the KraneModule. return $KM } default { Throw "Project type $ProjectType not supported" } } Write-Debug "[KraneFactory][GetProject([System.IO.FileInfo])] End" Throw "Project type $ProjectType not supported" #For some strange reason, having the throw in the switch statement does no suffice for the compiler... } #endregion } Class NuSpecFile { <# .SYNOPSIS Represents a NuSpec file. #> #region Properties [KraneModule]$KraneModule [String]$Version [System.IO.DirectoryInfo]$ExportFolderPath [System.IO.FileInfo]$NuSpecFilePath [xml]$NuSpecXml hidden [String]$RawContent #endregion #region Constructors <# .SYNOPSIS Constructor .DESCRIPTION This constructor will create a new NuSpecFile object. .PARAMETER KraneModule The KraneModule object that will be used to create the NuSpec file. #> NuspecFile([KraneModule]$KraneModule) { Write-Debug "[NuSpecFile][Constructor([KraneModule])] Start" $this.SetKraneModule($KraneModule) $this.ExportFolderPath = Join-Path -Path $this.KraneModule.Outputs -ChildPath "Nuget" Write-Debug "[NuSpecFile][Constructor([KraneModule])] Nuget folder -> '$($this.ExportFolderPath.FullName)'" $Modulefolder = Join-Path -Path $this.KraneModule.Outputs.FullName -ChildPath "Module" $this.NuSpecFilePath = Join-Path -Path $Modulefolder -ChildPath ($this.KraneModule.ModuleName + ".nuspec") Write-Debug "[NuSpecFile][Constructor([KraneModule])] Nuspec file path -> $($this.NuSpecFilePath.FullName)" $this.FetchNuSpecContent() Write-Debug "[NuSpecFile][Constructor([KraneModule])] Start" } #endregion #region Methods <# .SYNOPSIS Sets the KraneModule object .PARAMETER KraneModule The KraneModule object that will be used to create the NuSpec file. #> [void] SetKraneModule([KraneModule]$KraneModule) { Write-Debug "[NuSpecFile][SetKraneModule([KraneModule])] Setting KraneModule" $this.KraneModule = $KraneModule } <# .SYNOPSIS Generates the content of the NuSpec file. .DESCRIPTION This method will generate the content of the NuSpec file based on the KraneModule object. #> [void] GenerateNuSpecContent(){ Write-Debug "[NuSpecFile][GenerateNuSpecContent()] Start" Write-Debug "[NuSpecFile][GenerateNuSpecContent()] Fetching NuSpec content." $this.FetchNuSpecContent() Write-Debug "[NuSpecFile][GenerateNuSpecContent()] Fetching psd1 data from '$($this.KraneModule.ModuleDataFile.FullName)'" $psd1Data = Import-PowerShellDataFile -Path $this.KraneModule.ModuleDataFile.FullName Write-Debug "[NuSpecFile][GenerateNuSpecContent()] Setting XML values in nuspec file." if ($this.NuSpecXml.package.metadata.id -ne $this.KraneModule.ModuleName) { Write-Debug "[NuSpecFile][GenerateNuSpecContent()] Updating id -> '$($this.KraneModule.ModuleName)'" $this.NuSpecXml.package.metadata.id = $this.KraneModule.ModuleName } if($this.Version -ne $this.KraneModule.ProjectVersion){ $this.Version = $this.KraneModule.ProjectVersion if(-not $this.NuSpecXml.package.metadata.version){ #Element doesn't exist yet in nuspec XML. Creating it. $Element = $this.NuSpecXml.CreateElement("version") $null = $this.NuSpecXml.Package.metadata.AppendChild($Element) } Write-Debug "[NuSpecFile][GenerateNuSpecContent()] Updating 'Version' -> '$($this.Version)'" $this.NuSpecXml.package.metadata.version = $this.Version } If ($Psd1Data.Author) { if(-not $this.NuSpecXml.package.metadata.authors){ #Element doesn't exist yet in nuspec XML. Creating it. $Element = $this.NuSpecXml.CreateElement("authors") $null = $this.NuSpecXml.Package.metadata.AppendChild($Element) } #Setting value in nuspec xml. Write-Debug "[NuSpecFile][GenerateNuSpecContent()] Author 'Author' -> '$($psd1Data.Author)'" $this.NuSpecXml.Package.metadata.authors = $psd1Data.Author } If ($Psd1Data.PrivateData.PsData.ProjectUri) { if (-not $this.NuSpecXml.package.metadata.projectUrl) { #Element doesn't exist yet in nuspec XML. Creating it. $Element = $this.NuSpecXml.CreateElement("projectUrl") $null = $this.NuSpecXml.Package.metadata.AppendChild($Element) } #Setting value in nuspec xml. Write-Debug "[NuSpecFile][GenerateNuSpecContent()] Updating 'ProjectUri' -> '$($psd1Data.PrivateData.PsData.ProjectUri)'" $this.NuSpecXml.package.metadata.projectUrl = $psd1Data.PrivateData.PsData.ProjectUri } If ($Psd1Data.PrivateData.PsData.tags) { if(-not $this.NuSpecXml.package.metadata.tags){ #Element doesn't exist yet in nuspec XML. Creating it. $Element = $this.NuSpecXml.package.metadata.CreateElement("tags") $null = $this.NuSpecXml.package.metadata.AppendChild($Element) } #Setting value in nuspec xml. Write-Debug "[NuSpecFile][GenerateNuSpecContent()] Updating 'Tags' -> '$($psd1Data.PrivateData.PsData.Tags)'" $this.NuSpecXml.Package.metadata.tags = $psd1Data.PrivateData.PsData.tags } If ($Psd1Data.description) { if (-not $this.NuSpecXml.package.metadata.description) { #Element doesn't exist yet in nuspec XML. Creating it. $Element = $this.NuSpecXml.CreateElement("description") $null = $this.NuSpecXml.package.metadata.AppendChild($Element) } #Setting value in nuspec xml. Write-Debug "[NuSpecFile][GenerateNuSpecContent()] Updating 'description' -> '$($psd1Data.description)'" $this.NuSpecXml.package.metadata.description = $psd1Data.description } If ($Psd1Data.PrivateData.PsData.releaseNotes) { if (-not $this.NuSpecXml.package.metadata.releaseNotes) { #Element doesn't exist yet in nuspec XML. Creating it. $Element = $this.NuSpecXml.CreateElement("releaseNotes") $null = $this.NuSpecXml.package.metadata.AppendChild($Element) } #Setting value in nuspec xml. Write-Debug "[NuSpecFile][GenerateNuSpecContent()] Updating 'releaseNotes' -> '$($Psd1Data.PrivateData.PsData.releaseNotes)'" $this.NuSpecXml.package.metadata.releaseNotes = $Psd1Data.PrivateData.PsData.releaseNotes } Write-Debug "[NuSpecFile][GenerateNuSpecContent()] Saving nuspec file at $($this.NuSpecFilePath.FullName)" $this.NuSpecXml.Save($this.NuSpecFilePath.FullName) Write-Debug "[NuSpecFile][GenerateNuSpecContent()] End" } <# .SYNOPSIS Creates the NuSpec file. #> [void] CreateNuSpecFile() { #TODO Remove this method ? Write-Debug "[NuSpecFile][CreateNuSpecFile()] Start" $this.GenerateNuSpecContent() Write-Debug "[NuSpecFile][CreateNuSpecFile()] End" } <# .SYNOPSIS Creates the NuGet file. #> [void] CreateNugetFile() { Write-Debug "[NuSpecFile][CreateNugetFile()] Start" if (!($this.ExportFolderPath.Exists)) { Write-Debug "[NuSpecFile][CreateNugetFile()] Lauching command 'nuget pack $($this.NuSpecFilePath.FullName) -OutputDirectory $($this.ExportFolderPath)'" $this.ExportFolderPath.Create() } & nuget pack $this.NuSpecFilePath.FullName -OutputDirectory $this.ExportFolderPath Write-Debug "[NuSpecFile][CreateNugetFile()] End" } <# .SYNOPSIS Fetches the content of the NuSpec file. #> FetchNuSpecContent(){ Write-Debug "[NuSpecFile][FetchNuSpecContent] Start" if ($this.NuSpecFilePath.Exists){ Write-Debug "[NuSpecFile][FetchNuSpecContent] NuSpec file found at $($this.NuSpecFilePath.FullName). Fetching existing content." $this.NuSpecXml = [xml](Get-Content -Path $this.NuSpecFilePath.FullName -Raw) $this.Version = $this.NuSpecXml.Package.Metadata.Version }else{ Write-Debug "[NuSpecFile][FetchNuSpecContent] NuSpec file not found at $($this.NuSpecFilePath.FullName). Generating base template." [xml]$XmlBaseTemplate = @" <?xml version="1.0" encoding="utf-8"?> <package> <metadata> <id></id> </metadata> </package> "@ $this.NuSpecXml = $XmlBaseTemplate } Write-Debug "[NuSpecFile][FetchNuSpecContent] End" } #endregion } Class PsFile { <# .SYNOPSIS Represents a PSFile file which is the base ps1 file that exists in PsKrane. #> #region properties [System.Io.FileInfo]$Path [object]$Content #endregion #region Constructors PsFile(){} <# .SYNOPSIS Constructor .PARAMETER Path The path to the file that will be used to create the PsFile object. #> PsFile([System.Io.FileInfo]$Path) { $this.Path = $Path if ($this.Path.Exists) { $this.Content = Get-Content -Path $this.Path.FullName -Raw } } #endregion #region Methods #endregion } Class BuildScript : PsFile { <# .SYNOPSIS Represents a PsKrane build script file. .DESCRIPTION #Creates the build script that will be used to build the module and create the nuspec file #> #region Properties [version]$Version [Bool]$IsCustom #endregion #region Constructors <# .SYNOPSIS Constructor .PARAMETER KraneModule The KraneModule object that will be used to create the build script. #> BuildScript([KraneModule]$KraneModule) { Write-Debug "[BuildScript][BuildScript([KraneModule])] Start" $this.Path = Join-Path -Path $KraneModule.Build.FullName -ChildPath "Build.Krane.ps1" $this.FetchContent() Write-Debug "[BuildScript][BuildScript([KraneModule])] End" } <# .SYNOPSIS Constructor .PARAMETER Path The path to the file that will be used to create the build script. #> BuildScript([System.Io.DirectoryInfo]$Path) { Write-Debug "[BuildScript][BuildScript([System.Io.DirectoryInfo])] Start" $this.Path = Join-Path -Path $Path.FullName -ChildPath "Build.Krane.ps1" Write-Debug "[BuildScript][BuildScript([System.Io.DirectoryInfo])] Fetching File content from $($this.Path.FullName)" $this.FetchContent() Write-Debug "[BuildScript][BuildScript([System.Io.DirectoryInfo])] End" } #endregion #region Methods <# .SYNOPSIS Fetches the content from the build script. #> [void] FetchContent(){ Write-Debug "[BuildScript][FetchContent()] Start" if ($this.Path.Exists) { Write-Debug "[BuildScript][FetchContent()] File found at $($this.Path.FullName). Parsing content." $this.Content = Get-Content -Path $this.Path.FullName if($this.Content[0] -match '^\#PsKrane\.BuildScript\.Version\s?=\s?(?<Version>.*$)'){ Write-Debug "[BuildScript][FetchContent()] setting version -> '$($Matches.Version)'" $this.Version = [version]::Parse($Matches.Version) } #The two first lines are the followings: #PsKrane.BuildScript.Version = 1.0.0 #PsKrane.BuildScript.IsCustom = false #The first line is represents the version of the file. #The second line represents if the script is a custom script (made by the user) or an official one delivered by PsKrane. #See complete script in the method: CreateBuildScript() $Custom = ($this.Content[1].Split("="))[1] Write-Debug "[BuildScript][FetchContent()] Script IsCustom -> '$($Custom)'" if($Custom){ $CustomCleaned = $Custom.Trim() if(($CustomCleaned -eq "true") -or ($CustomCleaned -eq "yes")){ $this.IsCustom = $true }else{ $this.IsCustom = $false } } } Write-Debug "[BuildScript][FetchContent()] End" } <# .SYNOPSIS Creates the build script that will be used to build the module and create the nuspec file #> [void] CreateBuildScript() { Write-Debug "[BuildScript][CreateBuildScript()] Start" $Content = @' #PsKrane.BuildScript.Version = 1.0.0 #PsKrane.BuildScript.IsCustom = false <# .SYNOPSIS This script is used to invoke PsKrane and to build the module and create the nuspec file .DESCRIPTION This script is used to invoke PsKrane and to build the module and create the nuspec file .PARAMETER SkipDownload This parameter is used to skip the download of the latest version of PsKrane. If omited, it will download the latest version of PsKrane available on the gallery. .PARAMETER Action This parameter is used to specify the action to be performed. The default value is "All". The possible values are "Build", "Nuget" and "All". .NOTES Use Invoke-KraneBuild to trigger this script in your build process. You can modify this script as you want with the condition to change the first line of the build script from: #PsKrane.BuildScript.Version = X.Y.Z to #PsKrane.BuildScript.Version = CUSTOM This will present Krane from overwriting this file in the future. #> Param( [Switch] $SkipDownload, [ValidateSet('Build','Nuget','All')] [string] $Action = "All" ) # This script is used to invoke PsKrane and to build the module and create the nuspec file if (-not $SkipDownload) { Install-Module PsKrane -Repository PSGallery -Force } import-Module PsKrane -Force $psr = $PSScriptRoot $Root = split-Path -Path $psr -Parent $KraneModule = Get-KraneProject -Root $Root switch ($Action) { "Build" { $KraneModule.BuildModule() } "Nuget" { New-KraneNugetFile -KraneModule $KraneModule -Force } "All" { $KraneModule.BuildModule() New-KraneNugetFile -KraneModule $KraneModule -Force } Default { throw "action '$($Action)' is not supported!" } } '@ Write-Debug "[BuildScript][CreateBuildScript()] Writing build script at '$($this.Path.FullName)'" $Content | Out-File -FilePath $this.Path.FullName -Encoding utf8 -Force Write-Debug "[BuildScript][CreateBuildScript()] End" } #endregion } <# .SYNOPSIS Represents a TestScript. .DESCRIPTION This class represents a test script file (Extension ending with *.Tests.ps1) #> Class TestScript : PsFile { #region Properties [string]$Name [string]$Content #endregion #region Constructors <# .SYNOPSIS Constructor .PARAMETER Path #> TestScript([System.IO.FileInfo]$Path) { Write-Debug "[TestScript][TestScript()] Start" if(-not $Path.Exists) { Throw "Test script file $($Path.FullName) does not exist" } $this.Path = $Path $this.Name = $Path.Name.Replace(".Tests.ps1","") Write-Debug "[TestScript][TestScript()] Fetching TestScript content from $($this.Path.FullName)" $this.Content = Get-Content -Path $this.Path.FullName -Raw Write-Debug "[TestScript][TestScript()] End" } <# .SYNOPSIS Constructor .PARAMETER KraneModule The KraneModule of the project .PARAMETER TestName The name of the script. #> TestScript([KraneModule]$KraneModule, [String]$TestName) { Write-Debug "[TestScript][TestScript([KraneModule],[String])] Start" $this.Name = $TestName if (!($TestName.Contains(".Tests.ps1"))) { $TestName = $TestName + ".Tests.ps1" } $this.Path = Join-Path -Path $KraneModule.Tests.FullName -ChildPath $TestName Write-Debug "[TestScript([KraneModule],[String])] End" } #enderegion #region Methods <# .SYNOPSIS Creates a test script #> [void] CreateTestScript() { Write-Debug "[PsKrane][TestScript][CreateTestScript()] Start" if (Test-Path $this.Path.FullName) { Write-debug "[PsKrane][TestScript][CreateTestScript]Test script $($this.Path.FullName) already exists" return } #Create the test script if ($this.Path.BaseName -match "^.*\.Tests$") { $ItemName = $this.Path.BaseName.Split(".")[0] }else{ $ItemName = $this.Path.BaseName } Write-debug "[PsKrane][TestScript][CreateTestScript]Fetching template for '$ItemName'" $this.Content = [TestScript]::GetTemplate($ItemName) Write-Debug "[PsKrane][TestScript][CreateTestScript]Creating Test script at -> $($this.Path.FullName)" $This.Content | Out-File -FilePath $this.Path.FullName -Encoding utf8 -Force Write-Debug "[PsKrane][TestScript][CreateTestScript] End" } <# .SYNOPSIS Returns the template for the test script .PARAMETER ItemName The name of the item that must be tested. This name will be used to replace the ###ITEMNAME### in the template. #> static [string] GetTemplate([String]$ItemName) { Write-Debug "[TestScript][GetTemplate([String])] Start" $Template = @' Generated with love using PsKrane Import-Module PsKrane [System.IO.DirectoryInfo]$psroot = $PSScriptRoot $KraneProject = Get-KraneProject -Root $PsRoot.Parent Import-Module $($KraneProject.ModuleDataFile.FullName) -Force InModuleScope -ModuleName $KraneProject.ModuleName -ScriptBlock { Describe "[###ITEMNAME###] Testing" { it "Should return Plop" { $result = ###ITEMNAME### $result | Should -Be "Plop" } } } '@ $TemplateWithItemName = $Template -replace '###ITEMNAME###', $ItemName Write-Debug "[TestScript][GetTemplate([String])] Start" return $TemplateWithItemName } #endregion } Class GitHelper { <# .SYNOPSIS Helper tools for Git related activies. #> #region properties [System.io.FileInfo]$Git #endregion #region Constructors <# .SYNOPSIS Constructor #> GitHelper() { Write-Debug "[GitHelper][GitHelper()] Start" $GitCommand = Get-Command -Name "git" if ($null -eq $GitCommand) { Throw "Git not found. Please install git and make sure it is in the PATH" } Write-Debug "[GitHelper][GitHelper()] git command found at $($GitCommand.Source)" $this.Git = $GitCommand.Source Write-Debug "[GitHelper][GitHelper()] End" } #endregion #region Methods <# .SYNOPSIS Creates a new git tag .PARAMETER Tag The tag to create #> GitTag([string]$Tag) { Write-Debug "[GitHelper][GitTag([String])] Start" try { Write-Debug "[GitHelper][GitTag] tagging with value -> $tag" $strOutput = & $this.Git.FullName tag -a $tag -m $tag 2>&1 if ($LASTEXITCODE -ne 0) { throw "Failed to write tag: $strOutput" } } catch { throw "Error creating tag $tag. $_" } Write-Debug "[GitHelper][GitTag([String])] Start" } <# .SYNOPSIS Creates a new git tag with annotation and message .PARAMETER TagAnnotation The annotation of the tag .PARAMETER TagMessage The message of the tag #> GitTag([string]$TagAnnotation, [String]$TagMessage) { Write-Debug "[GitHelper][GitTag([String],[String])] Start" try { Write-Debug "[GitHelper][GitTag] tagging with anonotation -> $TagAnnotation and message $TagMessage" $strOutput = & $this.Git.FullName tag -a $TagAnnotation -m $TagMessage 2>&1 if ($LASTEXITCODE -ne 0) { throw "Failed to write tag: $strOutput" } } catch { throw "Error creating tag with annotation : $TagAnnotation and message: $TagMessage. error -> $_" } Write-Debug "[GitHelper][GitTag([String],[String])] End" } <# .SYNOPSIS Creates a new git commit .PARAMETER Message The message of the commit #> GitCommit([string]$Message) { Write-Debug "[GitHelper][GitCommit([String])] Start" try { Write-Debug "[GitHelper][GitCommit([String])] commit with message -> $Message" $strOutput = & $this.Git.FullName commit -m $Message 2>&1 if ($LASTEXITCODE -ne 0) { throw "Failed to commit: $strOutput" } } catch { throw "Error creating commit. $_" } Write-Debug "[GitHelper][GitCommit([String])] End" } <# .SYNOPSIS Add the changes to the git staging area. .PARAMETER Path The path of the file to add the changes from. #> GitAdd([string]$Path) { Write-Debug "[GitHelper][GitAdd([String])] Start" try { & $this.Git.FullName add $Path } catch { throw "Error adding $Path to git. $_" } Write-Debug "[GitHelper][GitAdd([String])] End" } GitPushTags() { Write-Debug "[GitHelper][GitAdd([String])] Start" $strOutput = "" try { #& $this.Git.FullName push --tags Write-Verbose "[GitHelper][GitPushTags] pushing tags" $strOutput = & $this.Git.FullName push --tags -q 2>&1 if ($LASTEXITCODE -ne 0) { throw "LastExitcode: $LASTEXITCODE . Failed to push tags. Received output: $strOutput" } } catch { throw "Error pushing tags to git. output: $($strOutput). Error content: $_" } Write-Debug "[GitHelper][GitAdd([String])] End" } <# .SYNOPSIS Pushes the changes to the remote repository and pushed the tags right after it. #> GitPushWithTags() { Write-Debug "[GitHelper][GitPushWithTags([String])] Start" try { Write-Debug "[GitHelper][GitPushWithTags([String])] pushing changes with tags" $strOutput = & $this.Git.FullName push --follow-tags 2>&1 if ($LASTEXITCODE -ne 0) { throw "Failed to push with tags: $strOutput" } } catch { throw "Error pushing with tags to git. $_" } Write-Debug "[GitHelper][GitPushWithTags([String])] End" } #endregion } Class PsFunction { <# .SYNOPSIS Represents a PowerShell function. #> #region Properties [string]$Name [bool]$IsPrivate [bool]$HasCommentBasedHelp [bool]$HasTest [System.Io.FileInfo]$TestPath $CommentBasedHelp [System.Io.FileInfo]$Path hidden $RawAst #endregion #region constructors <# .SYNOPSIS Constructor .PARAMETER FunctionAst The function definition ast .PARAMETER IsPrivate A boolean that indicates if the function is private or not. #> PsFunction([System.Management.Automation.Language.FunctionDefinitionAst]$FunctionAst, [bool]$IsPrivate) { Write-Verbose "[PsFunction] Creating function: $($FunctionAst.Name) IsPrivate: $IsPrivate" $this.RawAst = $FunctionAst $this.Name = $FunctionAst.Name $this.IsPrivate = $IsPrivate $this.HasCommentBasedHelp = $FunctionAst.GetHelpContent().Length -gt 0 $this.CommentBasedHelp = $FunctionAst.GetHelpContent() } #endregion #region methods #endregion } Class PsModule { <# .SYNOPSIS Represents a PowerShell module construct (psd1 + psm1) and their contents. #> #region properties [String]$ModuleName [System.IO.FileInfo]$ModuleFile [System.IO.FileInfo]$ModuleDataFile [bool] $IsPresent [System.Collections.ArrayList]$Classes = [System.Collections.ArrayList]::New() [System.Collections.ArrayList]$Functions = [System.Collections.ArrayList]::New() [System.Collections.ArrayList]$Tests = [System.Collections.ArrayList]::New() Hidden [System.Collections.Hashtable]$ModuleData = @{} #endregion #region Constructors <# .SYNOPSIS Constructor .PARAMETER Path The path to the module file. #> PsModule([System.IO.FileInfo]$Path) { Write-Debug "[PsModule][PsModule()] Start" Write-Debug "[PsModule][PsModule()] working with '$($Path.FullName)'" if ($Path.Extension -ne '.psm1') { throw "Invalid file type $($Path.Extension) for module file '$($Path.FullName)'" } $this.ModuleFile = $Path $this.ModuleName = $Path.BaseName $PsdFileName = $Path.FullName.Replace('.psm1', '.psd1') $this.ModuleDataFile = $PsdFileName Write-Debug "[PsModule][PsModule()] fetching data from $($this.ModuleDataFile.FullName)" $this.FetchDataFileContent() if ($Path.Exists) { Write-Debug "[PsModule][PsModule()] PSM1 file detected -> $($Path.FullName)" $this.IsPresent = $true $this.GetAstClasses($Path) $this.GetASTFunctions($Path) } else { $this.IsPresent = $false } #We are assuming that the Tests folder is located at the root level as the module file / at the same level as the .krane.json file $TestFolder = $Path.Directory.Parent.Parent.FullName + "\Tests" Write-Debug "[PsModule][PsModule()] fetching tests from '$($TestFolder)'" $this.FetchTests($TestFolder) Write-Debug "[PsModule][PsModule()] End" } #endregion #region Methods GetAstClasses([System.IO.FileInfo]$p) { <# .SYNOPSIS Fetches the classes from the module file. .PARAMETER p The module file from where to fetch the classes. #> Write-Debug "[PsModule][GetAstClasses([System.IO.FileInfo])] Start" $p.Refresh() Write-Debug "[PsModule][GetAstClasses([System.IO.FileInfo])] Fetching classes from $($p.FullName)" If ( $P.Exists) { $Raw = [System.Management.Automation.Language.Parser]::ParseFile($p.FullName, [ref]$null, [ref]$Null) $ASTClasses = $Raw.FindAll( { $args[0] -is [System.Management.Automation.Language.TypeDefinitionAst] }, $true) foreach ($ASTClass in $ASTClasses) { Write-Debug "[PsModule][GetAstClasses([System.IO.FileInfo])] Detected class -> '$($AstClass.Name)'" $null = $this.Classes.Add($ASTClass) } } Write-Debug "[PsModule][GetAstClasses([System.IO.FileInfo])] Start" } #TODO Refactor this method, so that it is used by GetASTFunctionS($Path) GetASTFunction([System.IO.FileInfo]$Path, [String]$FunctionName) { <# .SYNOPSIS Fetches a function from the module file. .PARAMETER Path The module file from where to fetch the function. .PARAMETER FunctionName The name of the function to fetch. #> Write-Debug "[PsModule][GetAstFunctions([System.IO.FileInfo], [String])] Start" $RawFunctions = $null Write-Debug "[PsModule][GetAstFunctions([System.IO.FileInfo], [String])] Fetching functions from $($Path.FullName)" $ParsedFile = [System.Management.Automation.Language.Parser]::ParseFile($Path.FullName, [ref]$null, [ref]$Null) $RawAstDocument = $ParsedFile.FindAll({ $args[0] -is [System.Management.Automation.Language.Ast] }, $true) If ( $RawASTDocument.Count -gt 0 ) { ## source: https://stackoverflow.com/questions/45929043/get-all-functions-in-a-powershell-script/45929412 $RawFunctions = $RawASTDocument.FindAll({ $args[0] -is [System.Management.Automation.Language.FunctionDefinitionAst] -and $($args[0].parent) -isnot [System.Management.Automation.Language.FunctionMemberAst] }) } $RawFunction = $RawFunctions | Where-Object { $_.Name -eq $FunctionName } if ($null -eq $RawFunction) { throw "Function $FunctionName not found in file $($Path.FullName)" } if ($this.ModuleData.FunctionsToExport -contains $RawFunction.Name) { $IsPrivate = $false } else { $IsPrivate = $true } Write-Verbose "[PsModule][GetAstFunctions([System.IO.FileInfo], [String])] Found function $($RawFunction.Name) IsPrivate: $IsPrivate" $Func = [PsFunction]::New($RawFunction, $IsPrivate) $ExistingFunction = $this.Functions | Where-Object { $_.Name -eq $FunctionName } if ($null -ne $ExistingFunction) { $this.Functions.Remove($ExistingFunction) } $null = $This.Functions.Add($Func) Write-Debug "[PsModule][GetAstFunctions([System.IO.FileInfo], [String])] End" } <# .SYNOPSIS Fetches the functions from the module file. .PARAMETER Path The module file from where to fetch the functions. #> GetASTFunctions([System.IO.FileInfo]$Path) { Write-Debug "[PsModule][GetAstFunctions([System.IO.FileInfo])] Start" Write-Debug "[PsModule][GetAstFunctions([System.IO.FileInfo])] Fetching functions from $($Path.FullName)" $RawFunctions = $null $ParsedFile = [System.Management.Automation.Language.Parser]::ParseFile($Path.FullName, [ref]$null, [ref]$Null) $RawAstDocument = $ParsedFile.FindAll({ $args[0] -is [System.Management.Automation.Language.Ast] }, $true) If ( $RawASTDocument.Count -gt 0 ) { ## source: https://stackoverflow.com/questions/45929043/get-all-functions-in-a-powershell-script/45929412 $RawFunctions = $RawASTDocument.FindAll({ $args[0] -is [System.Management.Automation.Language.FunctionDefinitionAst] -and $($args[0].parent) -isnot [System.Management.Automation.Language.FunctionMemberAst] }) } $AllExportedFunctions = (Import-PowershellDataFile -Path $this.ModuleDataFile.FullName).FunctionsToExport foreach ($RawFunction in $RawFunctions) { $CleanedName = $RawFunction.Name.Replace(".ps1","") if ($AllExportedFunctions -contains $CleanedName) { $IsPrivate = $false } else{ $IsPrivate = $true } Write-Verbose "[PsModule][GetAstFunctions([System.IO.FileInfo])] Found function $($RawFunction.Name) IsPrivate: $IsPrivate" $Func = [PsFunction]::New($RawFunction, $IsPrivate) $null = $This.Functions.Add($Func) } Write-Debug "[PsModule][GetAstFunctions([System.IO.FileInfo])] End" } <# .SYNOPSIS Fetch the existing tests .PARAMETER TestsFolderPath The folder where the tests are located. #> FetchTests([System.IO.DirectoryInfo]$TestsFolderPath) { Write-Debug "[PsModule][FetchTests([System.IO.DirectoryInfo])] Start" $null = $this.Tests.Clear() $AllTestFiles = Get-ChildItem -Path $TestsFolderPath.FullName -File -Recurse $TotalTestFilesCount = ($AllTestFiles | Measure-Object).Count Write-Debug "[PsModule][FetchTests([System.IO.DirectoryInfo])] Found $TotalTestFilesCount!" foreach($TestFile in $AllTestFiles){ Write-Debug "[PsModule][FetchTests([System.IO.DirectoryInfo])] Adding '$($TestFile.FullName)'" $Test = [TestScript]::New($TestFile) $null = $this.Tests.Add($Test) } Write-Debug "[PsModule][FetchTests([System.IO.DirectoryInfo])] Creating link between existing functions and their tests." foreach($function in $this.Functions){ $function.HasTest = $false $Test = $this.Tests | Where-Object { $_.Name.Replace(".Tests.ps1","") -eq $function.Name } if($null -ne $Test){ $function.HasTest = $true $function.TestPath = $Test.Path Write-Debug "[PsModule][FetchTests([System.IO.DirectoryInfo])] Function '$($Function.Name)' has test at '$($test.Path)'" }else{ Write-Debug "[PsModule][FetchTests([System.IO.DirectoryInfo])] Function '$($Function.Name)' has No test detected! " } } Write-Debug "[PsModule][FetchTests([System.IO.DirectoryInfo])] End" } <# .SYNOPSIS Returns all the discovered tests. #> [TestScript[]] GetTests() { Write-Debug "[PsModule][GetTests()] Start" if($null -eq $this.Tests){ $this.FetchTests() } Write-Debug "[PsModule][GetTests()] End" return $this.Tests } <# .SYNOPSIS Returns all discovered classes #> [Object[]] GetClasses() { Write-Debug "[PsModule][GetClasses()] returning classes" return $this.Classes } [Object[]] GetAllFunctions() { Write-Debug "[PsModule][GetAllFunctions()] Returning functions" return $this.Functions } <# .SYNOPSIS The reverse build will create individual ps1 files, based on the contents of an existing .psm1 file. .DESCRIPTION This method will take the module file and extract the content to the sources folder and put the functions in the right folder. It is recommended to export to a folder called 'Sources' as other internal Krane functions and methods rely on this folder structure. By default, the files are NOT overwritten. Set $Force = $True to overwrite existing files. .PARAMETER Force Overwrites existing files #> [void] ReverseBuild([Bool]$Force) { write-debug "[PsModule][ReverseBuild([bool])] Start" $ExportFolderPath = $This.GetClassFolderPath().Parent [System.IO.DirectoryInfo]$PrivatePath = Join-Path -Path $ExportFolderPath.FullName -ChildPath "Functions/Private" [System.IO.DirectoryInfo]$PublicPath = Join-Path -Path $ExportFolderPath.FullName -ChildPath "Functions/Public" [System.IO.DirectoryInfo]$ClassesFolder = Join-Path -Path $ExportFolderPath.FullName -ChildPath "Classes" if ($PrivatePath.Exists -eq $false) { write-debug "[PsModule][ReverseBuild([bool])] Creating folder -> $($PrivatePath.FullName)" $null = New-Item -Path $PrivatePath.FullName -ItemType "directory" -Force } if ($PublicPath.Exists -eq $false) { write-debug "[PsModule][ReverseBuild([bool])] Creating folder -> $($PublicPath.FullName)" $null = New-Item -Path $PublicPath.FullName -ItemType "directory" -Force } if ($ClassesFolder.Exists -eq $false) { write-debug "[PsModule][ReverseBuild([bool])] Creating folder -> $($ClassesFolder.FullName)" $null = New-Item -Path $ClassesFolder.FullName -ItemType "directory" -Force } $ParameterSplat = @{} $ParameterSplat.Force = $Force $ParameterSplat.Encoding = 'utf8' write-debug "[PsModule][ReverseBuild([bool])] Starting export of functions to individual files process" foreach ($funct in $this.functions) { $FileName = $funct.Name + ".ps1" if ($funct.IsPrivate) { $FullExportPath = Join-Path -Path $PrivatePath.FullName -ChildPath $FileName write-verbose "[PsModule][ReverseBuild([bool])] Exporting Private function '$($funct.Name)' to -> '$($FullExportPath)'" $funct.RawAst.Extent.Text | Out-File -FilePath $FullExportPath @ParameterSplat } else { $FullExportPath = Join-Path -Path $PublicPath.FullName -ChildPath $FileName write-verbose "[PsModule][ReverseBuild([bool])] Exporting public function '$($funct.Name)' to -> '$($FullExportPath)'" $funct.RawAst.Extent.Text | Out-File -FilePath $FullExportPath @ParameterSplat } } foreach ($Class in $this.Classes) { $FileName = $Class.Name + ".ps1" $FullExportPath = Join-Path -Path $ClassesFolder.FullName -ChildPath $FileName Write-Verbose "[PsModule][ReverseBuild([bool])] Exporting class '$($Class.Name)' to -> '$($FullExportPath)'" $Class.Extent.Text | Out-File -FilePath $FullExportPath @ParameterSplat } write-debug "[PsModule][ReverseBuild([bool])] End" } <# .SYNOPSIS Reverse build for a single item (function or class) .PARAMETER Name Name of the item to reverse build .PARAMETER Force Forces the overwrite of an existing file in case it is already present #> [void] ReverseBuild([String]$Name, [Bool]$Force) { #This method reverse builds a single function or class. write-Debug "[PsModule][ReverseBuild([String]Name,[Bool]Force)] Starting operations" $ParameterSplat = @{ Force = $Force Encoding = 'utf8' } $this.GetASTFunction($this.ModuleFile.FullName,$Name) $Function = $this.Functions | Where-Object { $_.Name -eq $Name } if($null -ne $Function){ #Element trying to reververse build is a function #The function is already existing. We will export it to the right folder, but we need to NOT touch the other existing functions. #GetAstFunctions will automatically load the functions and classes into the $this.PsModule.Functions list. #Since we are only interested in one function, we will backup the existing functions and classes and then reload the functions from the backup. $FileName = $Function.Name + ".ps1" if ($Function.IsPrivate) { $PrivatePath = $this.GetPrivateFolderPath() $FullExportPath = Join-Path -Path $PrivatePath.FullName -ChildPath $FileName write-Debug "[PsModule][ReverseBuild([String]Name,[Bool]Force)] Exporting Private function '$($Function.Name)' to -> '$($FullExportPath)'" $Function.RawAst.Extent.Text | Out-File -FilePath $FullExportPath @ParameterSplat } else { $PublicPath = $this.GetPublicFolderPath() $FullExportPath = Join-Path -Path $PublicPath.FullName -ChildPath $FileName Write-Debug "[PsModule][ReverseBuild([String]Name,[Bool]Force)] Exporting public function '$($Function.Name)' to -> '$($FullExportPath)'" $Function.RawAst.Extent.Text | Out-File -FilePath $FullExportPath @ParameterSplat } } else{ #$Name is a not a function, trying to see if it is a class $Class = $this.GetClasses() | Where-Object { $_.Name -eq $Name } if($null -ne $Class){ $ClassesFolder = $this.GetClassFolderPath() $FileName = $Class.Name + ".ps1" $FullExportPath = Join-Path -Path $ClassesFolder.FullName -ChildPath $FileName Write-Debug "[PsModule][ReverseBuild([String]Name,[Bool]Force)] Exporting class '$($Class.Name)' to -> '$($FullExportPath)'" $Class.Extent.Text | Out-File -FilePath $FullExportPath @ParameterSplat } else{ throw "[PsModule][ReverseBuild([String]Name,[Bool]Force)] Item $Name not found as either class nor function." } } write-Debug "[PsModule][ReverseBuild([String]Name,[Bool]Force)] End of operations" } <# .SYNOPSIS This method will write a pester test for a specific item (function or class). .PARAMETER KraneModule The kraneModule to use. .PARAMETER Name The name of the function or the class for which tests should be created for. #> [void]WriteTest([KraneModule]$KraneModule,[string]$Name) { Write-Debug "[PsModule][WriteTest([KraneModule],[string])] Start" #Write the tests to the test folder #writing tests for functions $ItemToCreate = $this.Functions| Where-Object { $_.Name -eq $Name } if($null -eq $ItemToCreate){ $ItemToCreate = $this.Classes | Where-Object { $_.Name -eq $Name } if($null -eq $ItemToCreate){ throw "[PsModule][WriteTest([KraneModule],[string])] Item function / Class named $Name is not found. Please ensure that $Name is already present in the module and try again." } } Write-Debug "[PsModule][WriteTest([KraneModule],[string])] Creating test for $($ItemToCreate.Name)" $TestScript = [TestScript]::New($KraneModule, $ItemToCreate.Name) $TestScript.CreateTestScript() Write-Debug "[PsModule][WriteTest([KraneModule],[string])] End" } <# .SYNOPSIS Will write ALL the tests for all elements found. .PARAMETER KraneModule The kranemodule to use from which the tests shall be created. #> [void]WriteTests([KraneModule]$KraneModule) { Write-Debug "[PsModule][WriteTests([KraneModule])] Start" $TotalFunctionsCount = ($this.Functions | Measure-Object).Count #writing tests for functions Write-Debug "[PsModule][WriteTests([KraneModule])] Creating tests for '$TotalFunctionsCount' functions" foreach($function in $this.Functions){ $TestScript = [TestScript]::New($KraneModule,$function.Name) $TestScript.CreateTestScript() } #writing tests for classes $TotalClassesCount = ($this.Classes | Measure-Object).Count Write-Debug "[PsModule][WriteTests([KraneModule])] Creating tests for '$TotalClassesCount' Classes" foreach($class in $this.Classes){ $TestScript = [TestScript]::New($KraneModule,$class.Name) $TestScript.CreateTestScript() } Write-Debug "[PsModule][WriteTests([KraneModule])] End" } <# .SYNOPSIS Gets the contents from module Manifest (.psd1) of the module. #> [void] FetchDataFileContent() { Write-Debug "[PsModule][FetchDataFileContent()] Start" #TODO Rename to FetchModuleManifestContent $this.ModuleDataFile.Refresh() if ($this.ModuleDataFile.Exists) { Write-Debug "[PsModule] PSD1 file detected. Importing file from -> $($this.ModuleDataFile.FullName). " $this.ModuleData = Import-PowerShellDataFile -Path $this.ModuleDataFile.FullName } else { Write-Debug "[PsModule] No PSD1 file found for $($this.ModuleDataFile.FullName)" } Write-Debug "[PsModule][FetchDataFileContent()] End" } <# .SYNOPSIS Fetching the data from the module manifest (.psd1) #> [void] FetchModuleData(){ Write-Debug "[PsModule][FetchModuleData()] Start" $this.FetchDataFileContent() $this.GetAstClasses($this.ModuleFile) $this.GetASTFunctions($this.ModuleFile) $this.FetchTests($this.ModuleFile.Directory.Parent.Parent.FullName + "\Tests") #The PsKrane convention stipulates that the Tests folder is located right under the root. We don't have access to the $KraneProject object here. Write-Debug "[PsModule][FetchModuleData()] End" } <# .SYNOPSIS returns public functions #> [PsFunction[]] GetPublicFunctions() { Write-Debug "[PsModule][GetPublicFunctions()] Returning public functions" return $this.Functions | Where-Object { $_.IsPrivate -eq $false } } <# .SYNOPSIS returns Private functions #> [PsFunction[]] GetPrivateFunctions() { Write-Debug "[PsModule][GetPrivateFunctions()] Returning Private functions" return $this.Functions | Where-Object { $_.IsPrivate -eq $true } } <# .SYNOPSIS returns private folder path functions #> [System.IO.DirectoryInfo] GetPrivateFolderPath() { [System.IO.DirectoryInfo]$Directory = Join-Path -Path $this.ModuleFile.Directory.Parent.Parent.FullName -ChildPath "Sources\Functions\Private" Write-Debug "[PsModule][GetPrivateFolderPath()] Returning Private folder path -> '$($Directory.FullName)'" return $Directory } <# .SYNOPSIS Returns the Public folder path. #> [System.IO.DirectoryInfo] GetPublicFolderPath(){ [System.IO.DirectoryInfo]$Directory = Join-Path -Path $this.ModuleFile.Directory.Parent.Parent.FullName -ChildPath "Sources\Functions\Public" Write-Debug "[PsModule][GetPublicFolderPath()] Returning public folder path -> '$($Directory.FullName)'" return $Directory } <# .SYNOPSIS Returns the Classes folder path. #> [System.IO.DirectoryInfo] GetClassFolderPath() { [System.IO.DirectoryInfo]$Directory = Join-Path -Path $this.ModuleFile.Directory.Parent.Parent.FullName -ChildPath "Sources\Classes" Write-Debug "[PsModule][GetClassFolderPath()] Returning Classes folder path -> '$($Directory.FullName)'" return $Directory } <# .SYNOPSIS Return all the public files #> [System.Io.FileInfo[]] GetPublicFunctionFiles(){ $AllFiles = Get-ChildItem -Path $this.GetPublicFolderPath().FullName -File $FilesCount = ($AllFiles | Measure-Object).Count Write-Debug "[PsModule][GetPublicFunctionFiles()] Returning '$FilesCount' public files" return $AllFiles } <# .SYNOPSIS Return all the Private files #> [System.Io.FileInfo[]] GetPrivateFunctionFiles(){ $AllFiles = Get-ChildItem -Path $this.GetPrivateFolderPath().FullName -File $FilesCount = ($AllFiles | Measure-Object).Count Write-Debug "[PsModule][GetPrivateFunctionFiles()] Returning '$FilesCount' public files" return $AllFiles } <# .SYNOPSIS Return all the classes files #> [System.Io.FileInfo[]] GetClassFiles(){ $AllFiles = Get-ChildItem -Path $this.GetClassFolderPath().FullName -File $FilesCount = ($AllFiles | Measure-Object).Count Write-Debug "[PsModule][GetClassFiles()] Returning '$FilesCount' public files" return $AllFiles } #endregion } Class TestHelper { <# .SYNOPSIS Parent TestHelper class #> } Class PesterTestHelper : TestHelper { <# .SYNOPSIS The Pester Test Helper #> #region properties [object]$TestData [String[]]$Path [String]$Version = "Latest" [System.IO.FileInfo[]]$Tests #endregion #region Constructors PesterTestHelper() {} <# .SYNOPSIS Constructor .PARAMETER TestsFolderPath The folder path where all the tests are located. By default, this is $PsKraneRoot\Tests #> PesterTestHelper([System.IO.DirectoryInfo]$TestsFolderPath) { Write-Debug "[PesterTestHelper][PesterTestHelper([System.IO.DirectoryInfo])] Start" #Constructor to build based on Tests folder path and Version of Pester $PesterModule = Get-Module -Name Pester -ListAvailable if(-not $PesterModule){ Write-Warning "A Pester module could not be found on the system." } $this.Path = $TestsFolderPath $this.Tests = Get-ChildItem -Path $TestsFolderPath -File -Recurse $TotalTestsCount = $null $TotalTestsCount = ($this.Tests | Measure-Object).count $this.Version = 'Latest' #Defautl is the latest version of Pester found on the system. Write-Debug "[PesterTestHelper][PesterTestHelper([System.IO.DirectoryInfo])] Total of '$($TotalTestsCount)' detected in '$($this.Path.FullName)'" Write-Debug "[PesterTestHelper][PesterTestHelper([System.IO.DirectoryInfo])] End" } #endregion #region Methods <# .SYNOPSIS Will silently invoque the Pester tests. #> [void] InvokeTests() { Write-Debug "[PesterTestHelper][InvokeTests()] Start" Write-Debug "[PesterTestHelper][InvokeTests()] Attempting to import 'Pester' version '$($this.Version)'" if ($this.Version -eq 'Latest') { Import-Module -Name Pester -Force } else { Import-Module -Name Pester -RequiredVersion $this.Version -Force -Global } Write-Debug "[PesterTestHelper][InvokeTests()] Launching pester tests silently in the background... " $this.TestData = Invoke-Pester -Path $this.Tests -PassThru -Show None Write-Debug "[PesterTestHelper][InvokeTests()] End" } <# .SYNOPSIS Invokes one or more specific pester test(s). .PARAMETER TestsPath Accepts eithern a string or an array of strings that should be the path to the test script(s) or the folder containing test scripts. #> [void] InvokeTests([String[]]$TestsPath) { Write-Debug "[PesterTestHelper][InvokeTests([string])] Start" if ([string]::IsNullOrEmpty($TestsPath)) { throw "[PesterTestHelper][InvokeTests([string])]No path provided for tests" } Write-Debug "[PesterTestHelper][InvokeTests([string])] Attempting to import 'Pester' version '$($this.Version)'" if ($this.Version -eq 'Latest') { Import-Module -Name Pester -Force } else { Import-Module -Name Pester -RequiredVersion $this.Version -Force -Global } $this.Path = $TestsPath Write-Debug "[PesterTestHelper][InvokeTests([string])] invoking Pester version '$($this.Version)' silently in the background." $this.TestData = Invoke-Pester -Path $TestsPath -PassThru -Show None Write-Debug "[PesterTestHelper][InvokeTests()] End" } <# .SYNOPSIS Sets the version of pester to use. #> [void] SetVersion([String]$Version) { Write-Debug "[PesterTestHelper][SetVersion([String])] Start" $this.Version = $Version Write-Debug "[PesterTestHelper][SetVersion([String])] End" } <# .SYNOPSIS Default ToString overload. #> [String] ToString() { Write-Debug "[PesterTestHelper][ToString()])] Start" $Message = "Result: {0} PassedCount: {1} FailedCount: {2}" -f $this.TestData.Result, $this.TestData.PassedCount, $this.TestData.FailedCount Write-Debug "[PesterTestHelper][ToString()])] Message -> '$Message'" Write-Debug "[PesterTestHelper][ToString()])] End" return $Message } <# .SYNOPSIS Returns all failed tests. #> [object] GetFailedTests() { $Count = ($this.TestData.Failed | Measure-Object).Count Write-Debug "[PesterTestHelper][GetFailedTests()])] Returning '$Count' Failed tests" return $this.TestData.Failed } <# .SYNOPSIS Returns all Passed tests. #> [object] GetPassedTests() { $Count = ($this.TestData.Passed | Measure-Object).Count Write-Debug "[PesterTestHelper][GetPassedTests()])] Returning '$Count' Passed tests" return $this.TestData.Passed } #endregion } function Get-KraneTestScript { <# .SYNOPSIS Retrieves a test script .DESCRIPTION Retrieves a test script .PARAMETER KraneModule The Krane module object .PARAMETER Name The name of the test script. .EXAMPLE Get-KraneTestScript -KraneModule $KraneModule -Name "TestScript" #> [CmdletBinding()] Param( [Parameter(Mandatory = $True)] [KraneModule]$KraneModule, [Parameter(Mandatory = $False)] [String]$Name ) if($Name){ if(-not $Name.EndsWith(".Tests.ps1")){ $Name = $Name.Replace(".Tests.ps1","") } $return = $KraneModule.PsModule.Tests | where-Object { $_.Name -eq $Name } return $return }else{ return $KraneModule.PsModule.Tests } } # Public functions Function Get-KraneProjectVersion { <# .SYNOPSIS Retrieves the version of the Krane project .DESCRIPTION Retrieves the version of the Krane project .PARAMETER KraneProject The Krane project object .EXAMPLE Get-KraneProjectVersion -KraneProject $KraneProject #> [CmdletBinding()] Param( [Parameter(Mandatory = $True)] [KraneProject]$KraneProject ) Return $KraneProject.KraneFile.Get("ProjectVersion") } Function New-KraneProject { <# .SYNOPSIS Creates a new Krane project .DESCRIPTION Will create a base .krane.json project file. The project can be either a module or a script. .PARAMETER Type Type of project to create. Can be either 'Module' or 'Script' .PARAMETER Name Name of the project .PARAMETER Path Root folder of the project .NOTES Author: Stéphane vg .LINK https://github.com/Stephanevg/PsKrane .EXAMPLE New-KraneProject -Type Module -Path C:\Users\Stephane\Code\KraneTest\wip -Name "wip" -verbose ModuleName : wip ModuleFile : C:\Users\Stephane\Code\KraneTest\wip\Outputs\Module\wip.psm1 ModuleDataFile : C:\Users\Stephane\Code\KraneTest\wip\Outputs\Module\wip.psd1 Build : C:\Users\Stephane\Code\KraneTest\wip\Build Sources : C:\Users\Stephane\Code\KraneTest\wip\Sources Tests : C:\Users\Stephane\Code\KraneTest\wip\Tests Outputs : C:\Users\Stephane\Code\KraneTest\wip\Outputs Tags : {PSEdition_Core, PSEdition_Desktop} Description : ProjectUri : KraneFile : ProjectName:wip ProjectType:Module ProjectType : Module Root : C:\Users\Stephane\Code\KraneTest\wip .EXAMPLE New-KraneProject -Type Module -Path C:\Users\Stephane\Code\KraneTest\plop -Name "Plop" C:\USERS\STEPHANE\CODE\KRANETEST\PLOP │ .krane.json ├───Build │ └───Build.Krane.ps1 ├───Outputs ├───Sources │ └───Functions │ ├───Private │ └───Public └───Tests .PARAMETER Type Type of project to create. Can be either 'Module' or 'Script' .PARAMETER Name Name of the project .PARAMETER Path Root folder of the project #> [cmdletBinding()] [OutputType([KraneProject])] Param( [Parameter(Mandatory = $True, HelpMessage = "Type of project to create. Can be either 'Module' or 'Script'")] [ProjectType]$Type, [Parameter(Mandatory = $True, HelpMessage = "Name of the project")] [String]$Name, [Parameter(Mandatory = $True, HelpMessage = "Root folder of the project")] [ValidateScript({ if(-not (Test-Path $_)){ throw "Path $_ doesn't exists" } $Item = Get-Item -Path $_ if($Item.GetType().Name -eq "DirectoryInfo"){ return $true }else{ throw "Path $_ is not a directory" } })] [object]$Path ) $ResolvedPath = Resolve-Path $Path $Path = Get-Item -Path $ResolvedPath.Path if ($Path.GetType().Name -ne "DirectoryInfo") { throw "Path $($Path.FullName) is not a directory" } [System.IO.DirectoryInfo]$DestinationPath = Join-Path -Path $Path.FullName -ChildPath $Name if ($DestinationPath.Exists) { $KraneFile = Get-ChildItem -Path $DestinationPath.FullName -Filter ".krane.json" if ($KraneFile) { Write-warning "[New-KraneProject] Project already exists at '$($DestinationPath.FullName)'." return } #Kranefile doesn't exists. This means the folder is empty. We can create the project } switch ($Type) { "Module" { $KraneProject = [KraneModule]::New($Path, $Name) } default { Throw "Project type $Type not supported" } } $KraneProject.CreateBaseStructure() Add-KraneBuildScript -KraneProject $KraneProject Return $KraneProject } Function New-KraneNuspecFile { <# .SYNOPSIS Creates a new NuSpec file .DESCRIPTION Creates a new Nuspec File based on a PsKrane project. To retrieve a the Nuspec file from an existing KraneProject, use Get-KraneNuSpecFile. .PARAMETER KraneProject The Krane project object .LINK https://github.com/Stephanevg/PsKrane .EXAMPLE $KraneProject = Get-KraneProject -Root C:\Plop\ New-KraneNuspecFile -KraneProject $KraneProject Generates a .nuspec file in .\Outputs\Module\ folder of the KraneProject #> Param( [Parameter(Mandatory = $True)] [KraneModule]$KraneModule ) $NuSpec = [NuSpecFile]::New($KraneModule) $NuSpec.CreateNuSpecFile() } function Get-KraneNuSpecFile { <# .SYNOPSIS Retrieves a NuSpec file .DESCRIPTION Retrieves a NuSpec file .PARAMETER KraneProject The Krane project object .EXAMPLE $KraneModule = Get-KraneProject -Root C:\Code\MyKraneModule Get-KraneNuSpecFile -KraneModule $KraneModule #> Param( [Parameter(Mandatory = $True)] [KraneProject]$KraneProject ) $NuSpec = [NuSpecFile]::New($KraneProject) return $NuSpec } Function Get-KraneProject { <# .SYNOPSIS Retrieves a Krane project .DESCRIPTION Retrieves a Krane project .PARAMETER Root The root folder of the project. If not specified, it assumes it is located in a folder called 'Build' in the root of the project. .EXAMPLE Get-KraneProject -Root C:\Code\MyKraneModule #> [CmdletBinding()] [OutputType([KraneProject])] Param( [Parameter(Mandatory = $False, HelpMessage = "Root folder of the project. If not specified, it assumes it is located in the current folder.")] [System.IO.DirectoryInfo]$Root ) # Retrieve parent folder if (!$Root) { #Stole this part from PSHTML $EC = Get-Variable ExecutionContext -ValueOnly $Root = $ec.SessionState.Path.CurrentLocation.Path write-Verbose "[Get-KraneProject] Root parameter was omitted. Using Current location: $Root" } ElseIf ($Root.Exists -eq $false) { Throw "Root $($Root.FullName) folder not found" } [System.IO.FileInfo]$KraneFile = Join-Path -Path $Root.FullName -ChildPath ".krane.json" If (!($KraneFile.Exists)) { Throw "No .Krane file found in $($Root.FullName). Verify the path, or create a new project using New-KraneProject" } write-Verbose "[Get-KraneProject] Fetching Krane project from path: $Root" Return [KraneFactory]::GetProject($KraneFile) } Function Add-KraneBuildScript { <# .SYNOPSIS Adds the build script 'Build.Krane.ps1' to the project. .DESCRIPTION Adds the build script to the project. The build script is used to invoke PsKrane and to build the module and create the nuspec file. This build script is buy default called Build.Krane.ps1 and located in the folder: '<KraneProject>\Build\'. The build script is created with a Base build template. But it is recommended to customize it to your needs. .PARAMETER Path The folder of where the Build.Krane.ps1 file should be created. .PARAMETER KraneProject The KraneProject object that represents the project .NOTES Author: Stephane van Gulick version: 0.1 .LINK http://github.com/stephanevg/PsKrane .EXAMPLE Add-BuildScript -Root C:\Users\Stephane\Code\KraneTest\wip #> [CmdletBinding()] Param( [Parameter(Mandatory = $False, ParameterSetName = "Path")] [System.IO.DirectoryInfo]$Path, [Parameter(Mandatory = $False, ParameterSetName = "KraneProject")] [KraneModule]$KraneProject ) Switch ($PSCmdlet.ParameterSetName) { "Path" { $BuildScript = [BuildScript]::New($Path) $BuildScript.CreateBuildScript() } "KraneProject" { $BuildScript = [BuildScript]::New($KraneProject.Build) $BuildScript.CreateBuildScript() } } } Function New-KraneTestScript { <# .SYNOPSIS Creates a new test script. .DESCRIPTION Creates a new test script in the Tests folder of the project. The Test script can be used for any purpose. If you want to create tests for existing functions / classes, have a look at Write-KraneTestScript .PARAMETER KraneProject The KraneProject object that represents the project Example: $KraneProject = Get-KraneProject .PARAMETER TestName The name of the test script .EXAMPLE New-KraneTestScript -KraneModule $KraneModule -TestName "Plop" Creates a new test script called Plop.Tests.ps1 in the Tests folder of the project #> [CmdletBinding()] Param( [Parameter(Mandatory = $True)] [KraneProject]$KraneProject, [Parameter(Mandatory = $True)] [String]$Name ) Write-Verbose "[New-KraneTestScript] Creating test '$Name'" $TestScript = [TestScript]::New($KraneProject, $Name) $TestScript.CreateTestScript() $KraneProject.PsModule.FetchTests($KraneProject.Tests.FullName) } #TODO TO delete ?? Function Write-KraneTestScript { <# .SYNOPSIS Creates one or more test scripts based on a $KraneModuleProject functions / Classes .DESCRIPTION Creates a new test script in the Tests folder of the project. Only tests for existing functions / classes can be created. .PARAMETER KraneProject The KraneProject object that represents the project (Use $KraneProject = Get-KraneProject to get the project) .PARAMETER Name The name of the function or class to write tests for. .EXAMPLE New-KraneTestScript -KraneModule $KraneModule -TestName "Plop" Creates a new test script called Plop.Tests.ps1 in the Tests folder of the project #> [CmdletBinding()] Param( [Parameter(Mandatory = $True)] [KraneProject]$KraneProject, [Parameter(Mandatory = $False,ParameterSetName = 'SingleItem')] [String]$Name, [Parameter(Mandatory = $False)] [Switch]$Force ) if($Name){ Write-Verbose "[Write-KraneTestScript] Creating test script for $Name" $KraneProject.PsModule.WriteTest($KraneProject,$Name) } else{ Write-Verbose "[Write-KraneTestScript] Creating test scripts for all functions" $KraneProject.PsModule.WriteTests($KraneProject) } $KraneProject.PsModule.FetchTests($KraneProject.Tests.FullName) } Function Invoke-KraneBuild { <# .SYNOPSIS Invokes the build script .DESCRIPTION Invokes the build script of the project. The build script is used to build the module and create the nuspec file. The build script is by default called Build.Krane.ps1 and located in the folder: '<KraneProject>\Build\'. The build script is created with a Base build template. But it is recommended to customize it to your needs. .PARAMETER KraneProject The KraneProject object that represents the project .EXAMPLE Invoke-KraneBuild -KraneProject $KraneProject #> [CmdletBinding()] Param( [KraneProject]$KraneProject ) $BuildFile = Join-Path -Path $KraneProject.Build.FullName -ChildPath "Build.Krane.ps1" if (!(Test-Path -Path $BuildFile)) { Throw "BuildFile $($BuildFile) not found. Please make sure it is there, and try again" } & $BuildFile } Function New-KraneNugetFile { <# .SYNOPSIS Creates a new nuget package .DESCRIPTION Create a new nuget package based for a specific kraneproject (Nuspec must already have been generated) .NOTES Information or caveats about the function e.g. 'This function is not supported in Linux' .LINK https://github.com/Stephanevg/PsKrane .EXAMPLE $KraneProject = Get-KraneProject -Root C:\Plop\ New-KraneNugetFile -KraneProject $KraneProject -Force Generates a .nupkg file in .\Outputs\Nuget\ folder of the KraneProject. -Force will create the nuspec file .PARAMETER KraneModule The KraneModule object that represents the project .PARAMETER Force Creates the nuspec file first #> Param( [Parameter(Mandatory = $True)] [KraneModule]$KraneModule, [Switch]$Force ) $NuSpec = [NuSpecFile]::New($KraneModule) if ($Force) { $NuSpec.CreateNuSpecFile() } $NuSpec.CreateNugetFile() } Function Invoke-KraneGitCommand { <# .SYNOPSIS Invokes a Git command .DESCRIPTION Invokes a Git command. The supported commands are: - tag: Creates a tag with the version of the project - PushTags: Pushes the tags to the remote repository - PushWithTags: Pushes the tags to the remote repository and pushes the changes .PARAMETER KraneProject The KraneProject object that represents the project .PARAMETER GitAction The Git action to perform. The supported actions are: 'tag', 'PushTags', 'PushWithTags' .PARAMETER Argument The argument to pass to the Git command. If not specified, the version of the project will be used. .EXAMPLE Invoke-KraneGitCommand -KraneProject $KraneProject -GitAction tag #> [CmdletBinding()] Param( [Parameter(Mandatory = $True)] [KraneProject]$KraneProject, [Parameter(Mandatory = $true)] [ValidateSet("tag", "PushTags", "PushWithTags")] [String]$GitAction, [String]$Argument ) $GitHelper = [GitHelper]::New() switch ($GitAction) { "tag" { if (!($Argument)) { $Argument = "v{0}" -f $KraneProject.ProjectVersion } Write-Verbose "[Invoke-KraneGitCommand] Invoking Git action $GitAction with argument $Argument" $GitHelper.GitTag($Argument) } "PushWithTags" { Write-Verbose "[Invoke-KraneGitCommand] Invoking Git action $GitAction" $GitHelper.GitPushWithTags() } "PushTags" { Write-Verbose "[Invoke-KraneGitCommand] Invoking Git action $GitAction" $GitHelper.GitPushTags() } } } Function Invoke-KraneTestScripts { <# .SYNOPSIS Invokes the test scripts .DESCRIPTION Invokes the test scripts of the project. The test scripts are used to test the functions and classes of the project. The test scripts are located in the folder: '<KraneProject>\Tests\'. .PARAMETER KraneProject The KraneProject object that represents the project .PARAMETER Version The version of Pester to use. By default, the latest version is used. .EXAMPLE Invoke-KraneTestScripts -KraneProject $KraneProject .EXAMPLE #with version 4.10.0 of Pester Invoke-KraneTestScripts -KraneProject $KraneProject -Version 4.10.0 #> [CmdletBinding()] Param( [Parameter(Mandatory = $True)] [KraneProject]$KraneProject, [Parameter(Mandatory = $False)] [String]$Version = "Latest" ) $TestHelper = [PesterTestHelper]::New() $TestHelper.SetVersion($Version) $TestHelper.InvokeTests($KraneProject.Tests.FullName) $KraneProject.TestData = $TestHelper Return $TestHelper } Enum LocationType { Module System Project } Class KraneTemplateCollection { [System.Collections.ArrayList]$Templates = [System.Collections.ArrayList]::New() [System.Io.DirectoryInfo]$ProjectLocationFolderPath [System.Io.DirectoryInfo]$SystemLocationFolderPath [System.Io.DirectoryInfo]$ModuleLocationFolderPath KraneTemplateCollection([KraneProject]$KraneProject) { Write-Debug "[KraneTemplateCollection][KraneTemplateCollection([KraneProject])] Start" $this.ModuleLocationFolderPath = "$($PSScriptRoot)\Templates" if ($global:PSVersionTable.os -match '^.*Windows.*$' ) { $this.SystemLocationFolderPath = "$($env:ProgramData)\PsKrane\Templates" } elseif ($env:IsLinux) { $this.SystemLocationFolderPath = " /opt/PsKrane/Templates" } elseif ($env:IsMacOS) { $this.SystemLocationFolderPath = "/Applications/PsKrane/Templates" } $ProjectRootFolder = $KraneProject.Root.FullName $this.ProjectLocationFolderPath = Join-Path -Path $ProjectRootFolder -ChildPath "Templates" $this.LoadAllTemplates() Write-Debug "[KraneTemplateCollection][KraneTemplateCollection([KraneProject])] End" } AddTemplate([KraneTemplate]$Template) { $null = $this.Templates.Add($Template) } [KraneTemplate[]] GetTemplates() { return $this.Templates } [KraneTemplate[]] GetTemplate([String]$Type) { $Template = $this.Templates | Where-Object { $_.Type -eq $Type } Return $Template } [KraneTemplate] GetTemplate([LocationType]$Location) { Write-Verbose "[KraneTemplateCollection] Getting template of by location -> $Location" $Template = $this.Templates | Where-Object { $_.Location -eq $Location } Return $Template } [KraneTemplate] GetTemplate([String]$Type, [LocationType]$Location) { Write-Verbose "[KraneTemplateCollection] Getting template of type $Type and location $Location" $Template = $this.Templates | Where-Object { $_.Type -eq $Type -and $_.Location -eq $Location } if ($null -eq $Template) { Throw "Template '$Type' of location type '$Location' not found" } Return $Template } [void] LoadAllTemplates() { Write-Debug "[KraneTemplateCollection][LoadAllTemplates()] Start" $this.LoadModuleTemplates() $this.LoadSystemTemplates() $this.LoadProjectTemplates() Write-Debug "[KraneTemplateCollection][LoadAllTemplates()] End" } [void] LoadModuleTemplates(){ Write-Debug "[KraneTemplateCollection][LoadModuleTemplates()] Start" $AllTemplates = Get-ChildItem -Path $this.ModuleLocationFolderPath.FullName -Filter "*.KraneTemplate.ps1" -ErrorAction SilentlyContinue foreach ($TemplateFile in $AllTemplates) { $Template = [KraneTemplate]::New($TemplateFile) $Template.SetLocation([LocationType]::Module) $this.AddTemplate($Template) } Write-Debug "[KraneTemplateCollection][LoadModuleTemplates()] End" } [void] LoadSystemTemplates(){ Write-Debug "[KraneTemplateCollection][LoadSystemTemplates()] Start" $AllTemplates = Get-ChildItem -Path $this.SystemLocationFolderPath.FullName -Filter "*.KraneTemplate.ps1" -ErrorAction SilentlyContinue foreach ($TemplateFile in $AllTemplates) { $Template = [KraneTemplate]::New($TemplateFile) $Template.SetLocation([LocationType]::System) $this.AddTemplate($Template) } Write-Debug "[KraneTemplateCollection][LoadSystemTemplates()] End" } [void] LoadProjectTemplates(){ Write-Debug "[KraneTemplateCollection][LoadProjectTemplates()] Start" $AllTemplates = Get-ChildItem -Path $this.ProjectLocationFolderPath.FullName -Filter "*.KraneTemplate.ps1" -ErrorAction SilentlyContinue foreach ($TemplateFile in $AllTemplates) { $Template = [KraneTemplate]::New($TemplateFile) $Template.SetLocation([LocationType]::Project) $this.AddTemplate($Template) } Write-Debug "[KraneTemplateCollection][LoadProjectTemplates()] End" } } Class KraneTemplate { [String]$Type hidden [String]$Content [System.Io.FileInfo]$Path [LocationType]$Location KraneTemplate([System.Io.FileInfo]$Path) { Write-Verbose '[KraneTemplate] Start Constructor [System.Io.FileInfo]$Path' if ($Path.Exists -eq $false) { Throw "Template file $($Path.FullName) not found" } $This.Type = $Path.BaseName.Split(".")[0] $this.Path = $Path $this.Content = Get-Content -Path $Path.FullName -Raw Write-Verbose "[KraneTemplate] End Constructor" } SetLocation([LocationType]$Location) { $this.Location = $Location } [String] ToString() { return "{0}->{1}" -f $this.Type, $this.Location } [string] GetContent() { Write-Verbose "[KraneTemplate] Getting content of template $($this.Path.FullName)" return $this.Content } } function New-KraneItem { <# .SYNOPSIS This function helps to create a new item in the project based on an existing template. .DESCRIPTION The new item that will be created is created based on an existing template. If the desired template doesn't exist, the operation will fail. Items in a krane project can be a private function, a public function or a class .PARAMETER KraneProject The KraneProject object that represents the project. .PARAMETER Name The name of the item to create. .PARAMETER Location This parameter specifies from where the template should be taken to create the item. The values that are supported are based on the values of enum 'LocationType'. By default, the location is set to 'Module' that is the location where the out-of-the-box templates are located. .PARAMETER Type The Type of the item to create. The Types that are supported are based on the values of enum 'KraneTemplateType'. .PARAMETER Visibility This parameter is ONLY available when Type is set to 'Function'. This setting allows to specify wheter a function should be 'Public' or 'Private'. This will result in the function being created in the right sub folder (functions/pubic or funtions/private). .LINK https://github.com/Stephanevg/PsKrane/ .EXAMPLE #The following example creates a new class called 'Myclass' in the krane project located at 'C:\MyKraneProject', and will use the tamplate located in the location 'Module'. $KraneProject = Get-KraneProject -Root "C:\MyKraneProject" New-KraneItem -KraneProject $KraneProject -Name Myclass -Type Class -Location 'Module' .EXAMPLE #The following example creates a new private function called 'plop' in the krane project located at 'C:\MyKraneProject' $KraneProject = Get-KraneProject -Root "C:\MyKraneProject" New-KraneItem -KraneProject $KraneProject -Name plop -Type Function -visibility "private" #> param( [Parameter(Mandatory = $True)] [KraneProject]$KraneProject, [Parameter(Mandatory = $True)] [KraneTemplateType]$Type, [Parameter(Mandatory = $True)] [String]$Name, [Parameter(Mandatory = $False)] [LocationType]$Location ) dynamicparam { # Create a dictionary to hold dynamic parameters $paramDictionary = New-Object System.Management.Automation.RuntimeDefinedParameterDictionary # Only create the FunctionType parameter if Type is "Function" if ($PSCmdlet.MyInvocation.BoundParameters["Type"] -eq "Function") { $attributeCollection = New-Object System.Collections.ObjectModel.Collection[System.Attribute] # Make the parameter mandatory when Type is "Function" $paramAttribute = New-Object System.Management.Automation.ParameterAttribute $paramAttribute.Mandatory = $true #Adding inline help. $paramAttribute.HelpMessage = "The visibility the function should have. Can be either 'Public' or 'Private'. In doubt, use 'Public'" # Define ValidateSet (Restricts input to "Public" or "Private") $validateSet = New-Object System.Management.Automation.ValidateSetAttribute("Public", "Private") $attributeCollection.Add($validateSet) $attributeCollection.Add($paramAttribute) # Define the parameter $functionTypeParam = New-Object System.Management.Automation.RuntimeDefinedParameter( "Visibility", [string], $attributeCollection ) # Add to dictionary $paramDictionary.Add("Visibility", $functionTypeParam) } return $paramDictionary } begin { # Retrieve dynamic parameter values if ($PSBoundParameters.ContainsKey("Visibility")) { $Visibility = $PSBoundParameters["Visibility"] } } process{ write-verbose "[New-KraneItem] Start of function" if($Name.EndsWith(".ps1")){ $Name = $Name.Replace(".ps1","") } write-verbose "[New-KraneItem] Creating new item of type '$Type' with name '$Name' in location '$Location'" #Any function can be of type Prive or Public. We will use the same template for both and copy the content to the right location. if($Type -and $Location){ $Template = $KraneProject.GetTemplate($Type, $Location) }else{ # If no location is specified, we will use the inheritance tree: # From closest to the script backwards: $Project -> $System -> $Module $Templates = $KraneProject.GetTemplates() | Where-Object -Filter {$_.Type -eq $Type} if(($Templates | Measure-Object).Count -eq 1){ #Only one template found matching the criteries. Giving that one back. $Template = $Templates }else{ $ProjectTemplate = $Templates | Where-Object -Filter {$_.Type -eq $Type -and $_.Location -eq "Project"} $SystemTemplate = $Templates | Where-Object -Filter {$_.Type -eq $Type -and $_.Location -eq "System"} $ModuleTemplate = $Templates | Where-Object -Filter {$_.Type -eq $Type -and $_.Location -eq "Module"} if($ProjectTemplate){ $Template = $ProjectTemplate }elseif($SystemTemplate){ $Template = $SystemTemplate }elseif($ModuleTemplate){ $Template = $ModuleTemplate } } } if ($null -eq $Template) { throw "No Template not found for '$Name' in location '$location'" } switch ($Type) { "Class" { $NewContent = $Template.GetContent().Replace('###ClassName###', $Name) $KraneProject.addClass($Name, $NewContent) } "Function" { $NewContent = $Template.GetContent().Replace('###FunctionName###', $Name) if ($Visibility -eq "Private") { $KraneProject.addPrivateFunction($Name, $NewContent) } else { $KraneProject.addPublicFunction($Name, $NewContent) } } "Test"{ #TODO Refactor, and either remove complete New-KRaneTestScript, or remove Test creation functionality from this function New-KraneTestScript -KraneProject $KraneProject -TestName $Name } default { throw "Type $Type not supported" } } #TODO Need to load the new data into $Krane.psmodule (getAllFunctions seems to NOT do the job. Add method 'LoadAll' ?) write-verbose "[New-KraneItem] End of function" } } function Get-KraneTemplate { <# .SYNOPSIS Retrieves all existing templates from a specific krane project. .DESCRIPTION Retrieves all existing templates from a specific krane project. .PARAMETER KraneProject The KraneProject object that represents the project. .PARAMETER Name The name of the template to retrieve. .PARAMETER Type The type of the template to retrieve. .PARAMETER Location The location where to search from to get the template. (System,Module,Project). .LINK https://www.github.com/stephanevg/PsKrane .EXAMPLE Get-KraneTemplate -KraneProject $KraneProject #> param( [Parameter(Mandatory = $True)] [KraneProject]$KraneProject, [Parameter(Mandatory = $False)] [String]$Name, [Parameter(Mandatory = $False)] [KraneTemplateType]$Type, [Parameter(Mandatory = $False)] [LocationType]$Location ) write-verbose "[Get-KraneTemplate] Start of function" $Template = $KraneProject.GetTemplates() if ($Name) { $Template = $Template | Where-Object { $_.Name -eq $Name } } #Since $Type is an Enum, when using if($type){} it is evaluated to be $false, although it DOES contain a value... #Using PsBoundParameters instead. if ($PSBoundParameters.ContainsKey("Type")) { $Template = $Template | Where-Object { $_.Type -eq $PSBoundParameters["Type"]} } if ($Location) { $Template = $Template | Where-Object { $_.Location -eq $Location } } if (-not $Template) { #No existing templates found. This can happen when several parameters are used, and some conditions are not met (name / location for instance). write-verbose "[Get-KraneTemplate] No templates found" return $null } write-verbose "[Get-KraneTemplate] End of function" return $Template } Function Invoke-KraneReverseBuild { <# .SYNOPSIS This function allows to decompose an existing .psm1 file into multiple individual .ps1 files. .DESCRIPTION Creates the individual function and class files (.ps1) based on the functions present in a .psm1 file. .NOTES Changelog: V1.0.0 14.01.2025 stephanevg -> Initial Creation .PARAMETER KraneModule The KraneModule object that represents the project .PARAMETER Force Overwrites the file(s) if already present. (Be sure you commit your changes BEFORE you use this one). .PARAMETER AddTests Allows to add a relevant test file. .PARAMETER ItemName Allows to limit the reverse build to a specific item. .EXAMPLE $KraneModule = Get-KraneProject -Root C:\MyModule\ Invoke-KraneReverseBuild -KraneModule $KraneModule .EXAMPLE #The following will add tests to you $KraneModule = Get-KraneProject -Root C:\MyModule\ Invoke-KraneReverseBuild -KraneModule $KraneModule -AddTests .EXAMPLE #The following limits the reverse build to a specific function called 'MyFunction' $KraneModule = Get-KraneProject -Root C:\MyModule\ Invoke-KraneReverseBuild -KraneModule $KraneModule -ItemName "MyFunction" #> [CmdletBinding()] Param( [Parameter(Mandatory = $True)] [KraneModule]$KraneModule, [Switch]$AddTests, [String]$ItemName, [Switch]$Force ) Write-Verbose "[Invoke-KraneReverseBuild] Starting operations" if($Force) { Write-Verbose "[Invoke-KraneReverseBuild] Force parameter detected. This will overwrite existing files. Make sure you have committed your changes before using this parameter" } if ($ItemName) { Write-Verbose "[Invoke-KraneReverseBuild] Limiting the reverse build to item $ItemName" $KraneModule.ReverseBuild($ItemName, $Force) }else{ Write-Verbose "[Invoke-KraneReverseBuild] Launching reverseBuild on all Item" $KraneModule.ReverseBuild($Force) Write-Verbose "[Invoke-KraneReverseBuild] Done" } if($AddTests){ Write-Verbose "[Invoke-KraneReverseBuild] AddTests parameter detected." if($ItemName){ $Functions = $KraneModule.psModule.Functions | Where-Object { $_.Name -eq $ItemName } }else{ $Functions = $KraneModule.psModule.Functions } foreach($function in $Functions){ Write-Verbose "[Invoke-KraneReverseBuild] Adding test function $($Function.Name)" New-KraneTestScript -Name $Function.Name -KraneProject $KraneModule } foreach($Class in $KraneModule.PsModule.Classes){ Write-Verbose "[Invoke-KraneReverseBuild] Adding test for function $($Function.Name)" New-KraneTestScript -Name $Class.Name -KraneProject $KraneModule } #Refreshing tests $KraneModule.PsModule.FetchTests($KraneModule.Tests) } Write-Verbose "[Invoke-KraneReverseBuild] End of operations" } function Get-KraneBuildScript { <# .SYNOPSIS Retrieves the build script .DESCRIPTION Retrieves the build script .PARAMETER KraneModule The Krane module object .EXAMPLE $KraneModule = Get-KraneProject -Root "C:\Code\Woope" Get-KraneBuildScript -KraneModule $KraneModule #returns Version IsCustom Path Content ------- -------- ---- ------- 1.0.0 False C:\Code\woope\Build\Build.Krane.ps1 {#PsKrane.BuildScript.Version = 1.0.0, #PsKrane.BuildScript.IsCustom = false, <#, .SYNOPSIS…} #> [CmdletBinding()] Param( [Parameter(Mandatory = $True)] [KraneModule]$KraneModule ) $BuildScript = [BuildScript]::New($KraneModule) Return $BuildScript } function Update-KraneBuildScript { <# .SYNOPSIS Updates the build script .DESCRIPTION Updates the build script .EXAMPLE Update-KraneBuildScript -KraneProject $KRanePRoject #> [CmdletBinding()] Param( [Parameter(Mandatory = $True)] [KraneModule]$KraneModule ) } |