Merge pull request #1583 from nikita-bykov/win-docs

Improve documentation for Android on Windows

images/win/scripts/SoftwareReport/SoftwareReport.Android.psm1

@@ -1,4 +1,11 @@
-function Get-AndroidComponentLocation {
+function Split-TableRowByColumns {
+    param(
+        [string] $Row
+    )
+    return $Row.Split("|") | ForEach-Object { $_.trim() }
+}
+
+function Get-AndroidSDKRoot {
     param(
         [string] $ComponentName
     )
@@ -6,24 +13,6 @@ function Get-AndroidComponentLocation {
     return "Location $path"
 }
 
-function Split-AndroidSDKOutputRow {
-    param(
-        [string] $Row
-    )
-    return $Row.Split("|").Trim()
-}
-
-function Create-AndroidTableObject {
-    param(
-        [string] $PackageName,
-        [string] $Description
-    )
-    return [PSCustomObject] @{
-        "Package Name" = $PackageName
-        "Description" = $Description
-    }
-}
-
 function Get-AndroidSDKManagerPath {
     return Join-Path $env:ANDROID_HOME "tools\bin\sdkmanager.bat"
 }
@@ -42,68 +31,120 @@ function Get-AndroidInstalledPackages {
     return $androidInstalledPackages
 }
 
-function Build-AndroidSDKToolsTable {
+
+function Build-AndroidTable {
+    $packageInfo = Get-AndroidInstalledPackages
+    return @(
+        @{
+            "Package" = "Android SDK Platform-Tools"
+            "Version" = Get-AndroidPackageVersions -PackageInfo $packageInfo -MatchedString "Android SDK Platform-Tools"
+        },
+        @{
+            "Package" = "Android SDK Tools"
+            "Version" = Get-AndroidPackageVersions -PackageInfo $packageInfo -MatchedString "Android SDK Tools"
+        },
+        @{
+            "Package" = "Android SDK Platforms"
+            "Version" = Get-AndroidPlatformVersions -PackageInfo $packageInfo
+        },
+        @{
+            "Package" = "Android SDK Build-tools"
+            "Version" = Get-AndroidBuildToolVersions -PackageInfo $packageInfo
+        },
+        @{
+            "Package" = "NDK"
+            "Version" = Get-AndroidPackageVersions -PackageInfo $packageInfo -MatchedString "ndk-bundle"
+        },
+        @{
+            "Package" = "Android Support Repository"
+            "Version" = Get-AndroidPackageVersions -PackageInfo $packageInfo -MatchedString "Android Support Repository"
+        },
+        @{
+            "Package" = "Google APIs"
+            "Version" = Get-AndroidGoogleAPIsVersions -PackageInfo $packageInfo
+        },
+        @{
+            "Package" = "Google Play services"
+            "Version" = Get-AndroidPackageVersions -PackageInfo $packageInfo -MatchedString "Google Play services"
+        },
+        @{
+            "Package" = "Google Repository"
+            "Version" = Get-AndroidPackageVersions -PackageInfo $packageInfo -MatchedString "Google Repository"
+        },
+        @{
+            "Package" = "SDK Patch Applier v4"
+            "Version" = Get-AndroidPackageVersions -PackageInfo $packageInfo -MatchedString "SDK Patch Applier v4"
+        },
+        @{
+            "Package" = "CMake"
+            "Version" = Get-AndroidPackageVersions -PackageInfo $packageInfo -MatchedString "cmake"
+        }
+    ) | Where-Object { $_.Version } | ForEach-Object {
+        [PSCustomObject] @{
+            "Package Name" = $_.Package
+            "Version" = $_.Version
+        }
+    }
+}
+
+function Get-AndroidPackageVersions {
     param (
         [Parameter(Mandatory)]
-        [object] $packageInfo
+        [object] $PackageInfo,
+        [Parameter(Mandatory)]
+        [object] $MatchedString
     )
 
-    return $packageInfo | ForEach-Object {
+    $versions = $packageInfo | Where-Object { $_ -Match $MatchedString } | ForEach-Object {
-        $packageInfoParts = Split-AndroidSDKOutputRow $_
+        $packageInfoParts = Split-TableRowByColumns $_
-        $packageName = $packageInfoParts[0]
+        return $packageInfoParts[1]
-        $packageDescription = $packageInfoParts[2] + ", Revision " + $packageInfoParts[1]
-        Create-AndroidTableObject -PackageName $packageName -Description $packageDescription
     }
+    return ($versions -Join "<br>")
 }
 
-function Build-AndroidSDKPlatformTable {
+function Get-AndroidPlatformVersions {
     param (
         [Parameter(Mandatory)]
-        [object] $packageInfo
+        [object] $PackageInfo
     )
 
-    return $packageInfo | ForEach-Object {
+    $versions = $packageInfo | Where-Object { $_ -Match "Android SDK Platform " } | ForEach-Object {
-        $packageInfoParts = Split-AndroidSDKOutputRow $_
+        $packageInfoParts = Split-TableRowByColumns $_
-        $packageName = $packageInfoParts[0].split(";")[1]
+        $revision = $packageInfoParts[1]
-        $packageDescription = $packageInfoParts[2] + ", Revision " + $packageInfoParts[1]
+        $version = $packageInfoParts[0].split(";")[1]
-        return Create-AndroidTableObject -PackageName $packageName -Description $packageDescription
+        return "$version (rev $revision)"
     }
+    [array]::Reverse($versions)
+    return ($versions -Join "<br>")
 }
 
-function Build-AndroidSDKBuildToolsTable {
+function Get-AndroidBuildToolVersions {
     param (
         [Parameter(Mandatory)]
-        [object] $packageInfo
+        [object] $PackageInfo
     )
 
-    return $packageInfo | ForEach-Object {
+    $versions = $packageInfo | Where-Object { $_ -Match "Android SDK Build-Tools" } | ForEach-Object {
-        $packageInfoParts = Split-AndroidSDKOutputRow $_
+        $packageInfoParts = Split-TableRowByColumns $_
-        $packageName = $packageInfoParts[0].replace(";", "-")
+        return $packageInfoParts[1]
-        $packageDescription = "Android SDK Build-Tools, Revision " + $packageInfoParts[1]
-        return Create-AndroidTableObject -PackageName $packageName -Description $packageDescription
     }
+    $groupVersions = @()
+    $versions | ForEach-Object {
+        $majorVersion = $_.Split(".")[0]
+        $groupVersions += $versions | Where-Object { $_.StartsWith($majorVersion) } | Join-String -Separator " "
+    }
+    return ($groupVersions | Sort-Object -Descending -Unique | Join-String -Separator "<br>")
 }
 
-function Build-AndroidExtraPackagesTable {
+function Get-AndroidGoogleAPIsVersions {
     param (
-        [Parameter(Mandatory)][AllowEmptyString()]
+        [Parameter(Mandatory)]
-        [string[]] $installedPackages
+        [object] $PackageInfo
     )
 
-    $extraPackages = @(
+    $versions = $packageInfo | Where-Object { $_ -Match "Google APIs" } | ForEach-Object {
-        "Android Support Repository",
+        $packageInfoParts = Split-TableRowByColumns $_
-        "Google Play services",
+        return $packageInfoParts[0].split(";")[1]
-        "Google Repository",
-        "ndk-bundle"
-    )
-
-    return $extraPackages | ForEach-Object {
-        $packageId = $_
-        $packageInfo = $installedPackages | Where-Object { $_ -Like "*${packageId}*" } | Select-Object -First 1
-        $packageInfoParts = Split-AndroidSDKOutputRow $packageInfo
-        return [PSCustomObject] @{
-            "Package Name" = $packageInfoParts[2]
-            "Version" = $packageInfoParts[1]
-        }
     }
+    return ($versions -Join "<br>")
 }

images/win/scripts/SoftwareReport/SoftwareReport.Generator.ps1

@@ -222,32 +222,8 @@ $markdown += Get-PowerShellModules | New-MDTable
 $markdown += New-MDNewLine
 
 # Android section
-$androidInstalledPackages = Get-AndroidInstalledPackages
+$markdown += New-MDHeader "Android" -Level 3
-
+$markdown += Build-AndroidTable | New-MDTable
-$markdown += New-MDHeader "Android SDK Tools" -Level 3
-$androidSDKTools = $androidInstalledPackages | Where-Object { $_ -Match "Android SDK Tools" -or $_ -Match "Android SDK Platform-Tools" }
-$markdown += Build-AndroidSDKToolsTable $androidSDKTools | New-MDTable
 $markdown += New-MDNewLine
 
-$markdown += New-MDHeader "Android SDK Platforms" -Level 3
-$androidSDKPlatforms = $androidInstalledPackages | Where-Object { $_ -Match "Android SDK Platform " }
-$markdown += New-MDInlineCode -Text (Get-AndroidComponentLocation -ComponentName "platforms")
-$markdown += New-MDNewLine
-$markdown += Build-AndroidSDKPlatformTable $androidSDKPlatforms | New-MDTable
-$markdown += New-MDNewLine
-
-$markdown += New-MDHeader "Android SDK Build-Tools" -Level 3
-$androidSDKBuildTools = $androidInstalledPackages | Where-Object { $_ -Match "Android SDK Build-Tools" }
-$markdown += New-MDInlineCode -Text (Get-AndroidComponentLocation -ComponentName "build-tools")
-$markdown += New-MDNewLine
-$markdown += Build-AndroidSDKBuildtoolsTable $androidSDKBuildTools | New-MDTable
-$markdown += New-MDNewLine
-
-$markdown += New-MDHeader "Android Extra Packages" -Level 3
-$markdown += Build-AndroidExtraPackagesTable $androidInstalledPackages | New-MDTable
-$markdown += New-MDNewLine
-
-$markdown += New-MDHeader "Cached Docker images" -Level 3
-$markdown += New-MDList -Style Unordered -Lines @(Get-CachedDockerImages)
-
 $markdown | Out-File -FilePath "C:\InstalledSoftware.md"