Add new cmdlet to test/report on meta file integrity

Author: jwittner

README.md

@@ -42,14 +42,12 @@ Get-UnitySetupInstance
 # 2017.2.0f3              Windows, UWP, UWP_IL2CPP, Vuforia C:\Program Files\Unity.2017.2.0f3\
 # 2017.3.0f3         Windows, UWP, UWP_IL2CPP, Mac, Vuforia C:\Program Files\Unity.2017.3.0f3\
 ```
-
 Select the Unity installs that you want:
 ```powershell
 Get-UnitySetupInstance | Select-UnitySetupInstance -Latest
 Get-UnitySetupInstance | Select-UnitySetupInstance -Version '2017.1.1f1'
 Get-UnitySetupInstance | Select-UnitySetupInstance -Project '.\MyUnityProject'
 ```
-
 Find all the Unity projects recursively:
 ```powershell
 Get-UnityProjectInstance -Recurse
@@ -77,6 +75,28 @@ Invoke methods with arbitrary arguments:
 ```powershell
 Start-UnityEditor -ExecuteMethod Build.Invoke -BatchMode -Quit -LogFile .\build.log -Wait -AdditionalArguments "-BuildArg1 -BuildArg2"
 ```
+Test the meta file integrity of Unity Projects:
+```powershell
+Test-UnityProjectInstanceMetaFileIntegrity # Test project in current folder
+Test-UnityProjectInstanceMetaFileIntegrity .\MyUnityProject
+Test-UnityProjectInstanceMetaFileIntegrity -Project .\MyUnityProject
+Get-UnityProjectInstance -Recurse | Test-UnityProjectInstanceMetaFileIntegrity
+
+# Example output:
+# True
+```
+Get meta file integrity issues for Unity Projects:
+```powershell
+Test-UnityProjectInstanceMetaFileIntegrity .\MyUnityProject -PassThru
+
+# Example output:
+# Item                                                              Issue
+# ----                                                              -----
+# C:\MyUnityProject\Assets\SomeFolder                               Directory is missing associated meta file.
+# C:\MyUnityProject\Assets\SomeFolder\SomeShader.shader             File is missing associated meta file.
+# C:\MyUnityProject\Assets\SomeFolder\SomeOtherShader.shader.meta   Meta file is missing associated item.
+```
+
 Find the installers for a particular version:
 ```powershell
 Find-UnitySetupInstaller -Version '2017.3.0f3' | Format-Table

UnitySetup/UnitySetup.psd1

@@ -79,6 +79,7 @@
         'Select-UnitySetupInstaller',
         'Test-UnitySetupInstance',
         'Get-UnityProjectInstance',
+        'Test-UnityProjectInstanceMetaFileIntegrity',
         'Get-UnitySetupInstance',
         'Request-UnitySetupInstaller',
         'Install-UnitySetupInstance',

UnitySetup/UnitySetup.psm1

@@ -1332,6 +1332,137 @@ function Get-UnityProjectInstance {
         }
 }
 
+<#
+.Synopsis
+   Tests the meta file integrity of the Unity Project Instance(s).
+.DESCRIPTION
+   Tests if every item under assets has an associated .meta file and every .meta file an associated item.
+.PARAMETER Project
+   Unity Project Instance(s) to test the meta file integrity of.
+.PARAMETER PassThru
+   Output the meta file integrity issues rather than $true (no issues) or $false (at least one issue).
+.EXAMPLE
+   Test-UnityProjectInstanceMetaFileIntegrity
+.EXAMPLE
+   Test-UnityProjectInstanceMetaFileIntegrity -PassThru
+.EXAMPLE
+   Test-UnityProjectInstanceMetaFileIntegrity .\MyUnityProject
+.EXAMPLE
+   Test-UnityProjectInstanceMetaFileIntegrity -Project .\MyUnityProject
+.EXAMPLE
+   Get-UnityProjectInstance -Recurse | Test-UnityProjectInstanceMetaFileIntegrity
+.EXAMPLE
+   Get-UnityProjectInstance -Recurse | Test-UnityProjectInstanceMetaFileIntegrity -PassThru
+#>
+function Test-UnityProjectInstanceMetaFileIntegrity {
+    [CmdletBinding(DefaultParameterSetName = "Context")]
+    param(
+        [Parameter(Mandatory = $true, ValueFromPipeline = $true, Position = 0, ParameterSetName = "Projects")]
+        [ValidateNotNullOrEmpty()]
+        [UnityProjectInstance[]] $Project,
+        [switch] $PassThru
+    )
+
+    process {
+
+        switch ( $PSCmdlet.ParameterSetName) {
+            'Context' {
+                $currentFolderProject = Get-UnityProjectInstance $PWD.Path
+                if ($null -ne $currentFolderProject) {
+                    $Project = @($currentFolderProject)
+                }
+            }
+        }
+
+        foreach ( $p in $Project) {
+
+            $testResult = $true
+
+            Write-Verbose "Getting meta file integrity for project at $($p.path)"
+            $assetDir = Join-Path $p.Path "Assets"
+
+            # get all the directories under assets
+            [System.IO.DirectoryInfo[]]$dirs = Get-ChildItem -Path "$assetDir/*" -Recurse -Directory -Exclude '.*'
+
+            Write-Verbose "Testing asset directories for missing meta files..."
+            foreach ($dir in $dirs) {
+                $testPath = "$($dir.FullName).meta";
+                if (Test-Path -PathType Leaf -Path $testPath) { continue }
+
+                if ($PassThru) {
+                    [PSCustomObject]@{
+                        'Item'  = $dir
+                        'Issue' = "Directory is missing associated meta file."
+                    }
+                }
+                else {
+                    $testResult = $false;
+                    break;
+                }
+            }
+
+            if (-not $testResult) { $false; continue; }
+
+            # get all the non-meta files under assets
+            [System.IO.FileInfo[]]$files = Get-ChildItem -Path "$assetDir/*" -Exclude '.*', '*.meta' -File
+            foreach ($dir in $dirs) {
+                $files += Get-ChildItem -Path "$($dir.FullName)/*" -Exclude '.*', '*.meta' -File
+            }
+
+            Write-Verbose "Testing asset files for missing meta files..."
+            foreach ( $file in $files ) {
+                $testPath = "$($file.FullName).meta";
+                if (Test-Path -PathType Leaf -Path $testPath) { continue }
+
+                if ($PassThru) {
+                    [PSCustomObject]@{
+                        'Item'  = $file
+                        'Issue' = "File is missing associated meta file."
+                    }
+                }
+                else {
+                    $testResult = $false;
+                    break;
+                }
+            }
+
+            if (-not $testResult) { $false; continue; }
+
+            $metaFileSearchArgs = @{
+                'Exclude' = '.*'
+                'Include' = '*.meta'
+                'File'    = $true
+                'Force'   = $true # Ensure we include hidden meta files
+            }
+
+            # get all the meta files under assets
+            [System.IO.FileInfo[]]$metaFiles = Get-ChildItem -Path "$assetDir/*" @metaFileSearchArgs
+            foreach ($dir in $dirs) {
+                $metaFiles += Get-ChildItem -Path "$($dir.FullName)/*" @metaFileSearchArgs
+            }
+
+            Write-Verbose "Testing meta files for missing assets..."
+            foreach ($metaFile in $metaFiles) {
+                $testPath = $metaFile.FullName.SubString(0, $metaFile.FullName.Length - $metaFile.Extension.Length);
+                if (Test-Path -Path $testPath) { continue }
+
+                if ($PassThru) {
+                    [PSCustomObject]@{
+                        'Item'  = $metaFile
+                        'Issue' = "Meta file is missing associated item."
+                    }
+                }
+                else {
+                    $testResult = $false;
+                    break;
+                }
+            }
+
+            if (-not $PassThru) { $testResult; }
+        }
+    }
+}
+
 <#
 .Synopsis
    Starts the Unity Editor