Committing the latest update-site contents to gh-pages branch.

detect10-3.2.0-SNAPSHOT.ps1

@@ -0,0 +1,393 @@
+# Detect Powershell Script
+# Recommended Invocation: powershell "irm https://detect.blackduck.com/detect.ps1?$(Get-Random) | iex; detect"
+$ProgressPreference = 'SilentlyContinue'
+function Get-EnvironmentVariable($Key, $DefaultValue) { if (-not (Test-Path Env:$Key)) { return $DefaultValue; }else { return (Get-ChildItem Env:$Key).Value; } }
+
+# DETECT_LATEST_RELEASE_VERSION should be set in your
+# environment if you wish to use a version different
+# from LATEST.
+$EnvDetectDesiredVersion = Get-EnvironmentVariable -Key "DETECT_LATEST_RELEASE_VERSION" -DefaultValue "";
+
+# To override the default version key, specify a
+# different DETECT_VERSION_KEY in your environment and
+# *that* key will be used to get the download url from
+# artifactory. These DETECT_VERSION_KEY values are
+# properties in Artifactory that resolve to download
+# urls for the detect jar file. As of 2024-10-04, the
+# available DETECT_VERSION_KEY values are:
+# DETECT_LATEST_10
+# Every new major version of detect will have its own
+# DETECT_LATEST_X key.
+$EnvDetectVersionKey = Get-EnvironmentVariable -Key "DETECT_VERSION_KEY" -DefaultValue "DETECT_LATEST_10";
+
+# If you want to skip the test for java
+# DETECT_SKIP_JAVA_TEST=1
+$EnvDetectSkipJavaTest = Get-EnvironmentVariable -Key "DETECT_SKIP_JAVA_TEST" -DefaultValue "";
+
+# You can specify your own download url from
+# artifactory which can bypass using the property keys
+# (this is mainly for QA purposes only)
+$EnvDetectSource = Get-EnvironmentVariable -Key "DETECT_SOURCE" -DefaultValue "";
+
+# To override the default location of /tmp, specify
+# your own DETECT_JAR_DOWNLOAD_DIR in your environment and
+# *that* location will be used.
+# *NOTE* We currently do not support spaces in the
+# DETECT_JAR_DOWNLOAD_DIR.
+# Otherwise, if the environment temp folder is set,
+# it will be used. Otherwise, a temporary folder will
+# be created in your home directory
+$EnvDetectFolder = Get-EnvironmentVariable -Key "DETECT_JAR_DOWNLOAD_DIR" -DefaultValue "";
+if ([string]::IsNullOrEmpty($EnvDetectFolder)) {
+	# Try again using old name for backward compatibility
+	$EnvDetectFolder = Get-EnvironmentVariable -Key "DETECT_JAR_PATH" -DefaultValue "";
+}
+
+$EnvTempFolder = Get-EnvironmentVariable -Key "TMP" -DefaultValue "";
+$EnvHomeTempFolder = "$HOME/tmp"
+
+
+# If you do not want to exit with the detect exit
+# code, set DETECT_EXIT_CODE_PASSTHRU to 1 and this
+# script won't exit, but simply return it (pass it thru).
+$EnvDetectExitCodePassthru = Get-EnvironmentVariable -Key "DETECT_EXIT_CODE_PASSTHRU" -DefaultValue "";
+
+# If you want to pass proxy information, use detect
+# environment variables such as 'blackduck.proxy.host'
+# If you do pass the proxy information in this way,
+# you do not need to supply it to detect as arguments.
+# Note: This script will not pick up proxy information
+# from the passed 'detect arguments'
+# Note: This script will not pick up proxy information
+# passed to the bash script using 'DETECT_CURL_OPTS'
+
+# To control which java detect will use to run, specify
+# the path in in DETECT_JAVA_PATH or JAVA_HOME in your
+# environment, or ensure that java is first on the path.
+# DETECT_JAVA_PATH will take precedence over JAVA_HOME.
+# JAVA_HOME will take precedence over the path.
+# Note: DETECT_JAVA_PATH should point directly to the
+# java executable. For JAVA_HOME the java executable is
+# expected to be in JAVA_HOME/bin/java
+$DetectJavaPath = Get-EnvironmentVariable -Key "DETECT_JAVA_PATH" -DefaultValue "";
+$JavaHome = Get-EnvironmentVariable -Key "JAVA_HOME" -DefaultValue "";
+
+# If you only want to download the appropriate jar file set
+# this to 1 in your environment. This can be useful if you
+# want to invoke the jar yourself but do not want to also
+# get and update the jar file when a new version releases.
+$DownloadOnly = Get-EnvironmentVariable -Key "DETECT_DOWNLOAD_ONLY" -DefaultValue "";
+
+# TODO: Mirror the functionality of the shell script
+# and allow Java opts.
+
+# If you want to pass any java options to the
+# invocation, specify DETECT_JAVA_OPTS in your
+# environment. For example, to specify a 6 gigabyte
+# heap size, you would set DETECT_JAVA_OPTS=-Xmx6G.
+# $DetectJavaOpts = Get-EnvironmentVariable -Key "DETECT_JAVA_OPTS" -DefaultValue "";
+
+$Version = "3.2.0-SNAPSHOT"
+
+[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 #Enable TLS2
+
+function Detect {
+    Write-Host "Detect Powershell Script $Version"
+
+    if ($EnvDetectSkipJavaTest -ne "1") {
+        if (Test-JavaNotAvailable) {
+            #If java is not available, we abort early.
+            $JavaExitCode = 127 #Command not found http://tldp.org/LDP/abs/html/exitcodes.html 
+            if ($EnvDetectExitCodePassthru -eq "1") {
+                return $JavaExitCode
+            }
+            else {
+                exit $JavaExitCode
+            }
+        }
+    }
+    else {
+        Write-Host "Skipping java test."
+    }
+
+    Write-Host "Initializing Detect folder."
+    $DetectFolder = Initialize-DetectFolder -DetectFolder $EnvDetectFolder -TempFolder $EnvTempFolder -HomeTempFolder $EnvHomeTempFolder
+
+    Write-Host "Checking for proxy."
+    $ProxyInfo = Get-ProxyInfo
+
+    Write-Host "Getting Detect."
+    $DetectJarFile = Get-DetectJar -DetectFolder $DetectFolder -DetectSource $EnvDetectSource -DetectVersionKey $EnvDetectVersionKey -DetectVersion $EnvDetectDesiredVersion -ProxyInfo $ProxyInfo
+
+    if ($DownloadOnly -ne "1") {
+        Write-Host "Executing Detect."
+        $DetectArgs = $args;
+        $DetectExitCode = Invoke-Detect -DetectJar $DetectJarFile -DetectArgs $DetectArgs
+
+        if ($EnvDetectExitCodePassthru -eq "1") {
+            return $DetectExitCode
+        } else {
+            exit $DetectExitCode
+        }
+    }
+}
+
+function Get-FirstFromEnv($Names) {
+    foreach ($Name in $Names) {
+        $Value = Get-EnvironmentVariable -Key $Name -Default $null;
+        if (-Not [string]::IsNullOrEmpty($Value)) {
+            return $Value;
+        }
+    }
+    return $null;
+}
+
+function Get-ProxyInfo () {
+    $ProxyInfoProperties = @{
+        'Uri'         = $null
+        'Credentials' = $null
+    }
+
+    try {
+
+        $ProxyHost = Get-FirstFromEnv @("blackduck.proxy.host", "BLACKDUCK_PROXY_HOST", "blackduck.hub.proxy.host", "BLACKDUCK_HUB_PROXY_HOST");
+
+        if ([string]::IsNullOrEmpty($ProxyHost)) {
+            Write-Host "Skipping proxy, no host found."
+        }
+        else {
+            Write-Host "Found proxy host."
+            $ProxyUrlBuilder = New-Object System.UriBuilder -ArgumentList $ProxyHost
+
+            $ProxyPort = Get-FirstFromEnv @("blackduck.proxy.port", "BLACKDUCK_PROXY_PORT", "blackduck.hub.proxy.port", "BLACKDUCK_HUB_PROXY_PORT");
+
+            if ([string]::IsNullOrEmpty($ProxyPort)) {
+                Write-Host "No proxy port found."
+            }
+            else {
+                Write-Host "Found proxy port."
+                $ProxyUrlBuilder.Port = $ProxyPort
+            }
+
+            $ProxyInfoProperties.Uri = $ProxyUrlBuilder.Uri
+
+            #Handle credentials
+            $ProxyUsername = Get-FirstFromEnv @("blackduck.proxy.username", "BLACKDUCK_PROXY_USERNAME", "blackduck.hub.proxy.username", "BLACKDUCK_HUB_PROXY_USERNAME");
+            $ProxyPassword = Get-FirstFromEnv @("blackduck.proxy.password", "BLACKDUCK_PROXY_PASSWORD", "blackduck.hub.proxy.password", "BLACKDUCK_HUB_PROXY_PASSWORD");
+
+            if ([string]::IsNullOrEmpty($ProxyPassword) -or [string]::IsNullOrEmpty($ProxyUsername)) {
+                Write-Host "No proxy credentials found."
+            }
+            else {
+                Write-Host "Found proxy credentials."
+                $ProxySecurePassword = ConvertTo-SecureString $ProxyPassword -AsPlainText -Force
+                $ProxyCredentials = New-Object System.Management.Automation.PSCredential ($ProxyUsername, $ProxySecurePassword)
+
+                $ProxyInfoProperties.Credentials = $ProxyCredentials;
+            }
+
+            Write-Host "Proxy has been configured."
+        }
+
+    }
+    catch [Exception] {
+        Write-Host ("An exception occurred setting up the proxy, will continue but will not use a proxy.")
+        Write-Host ("  Reason: {0}" -f $_.Exception.GetType().FullName);
+        Write-Host ("  Reason: {0}" -f $_.Exception.Message);
+        Write-Host ("  Reason: {0}" -f $_.Exception.StackTrace);
+    }
+
+    $ProxyInfo = New-Object -TypeName PSObject -Prop $ProxyInfoProperties
+
+    return $ProxyInfo;
+}
+
+function Invoke-WebRequestWrapper($Url, $ProxyInfo, $DownloadLocation = $null) {
+    $parameters = @{}
+    try {
+        if ($DownloadLocation -ne $null) {
+            $parameters.Add("OutFile", $DownloadLocation);
+        }
+        if ($ProxyInfo -ne $null) {
+            if ($ProxyInfo.Uri -ne $null) {
+                $parameters.Add("Proxy", $ProxyInfo.Uri);
+            }
+            if ($ProxyInfo.Credentials -ne $null) {
+                $parameters.Add("ProxyCredential", $ProxyInfo.Credentials);
+            }
+        }
+    }
+    catch [Exception] {
+        Write-Host ("An exception occurred setting additional properties on web request.")
+        Write-Host ("  Reason: {0}" -f $_.Exception.GetType().FullName);
+        Write-Host ("  Reason: {0}" -f $_.Exception.Message);
+        Write-Host ("  Reason: {0}" -f $_.Exception.StackTrace);
+    }
+
+    return Invoke-WebRequest $Url -UseBasicParsing @parameters -UserAgent "PowerShell" # Workaround for https://www.jfrog.com/jira/si/jira.issueviews:issue-html/RTFACT-26216/RTFACT-26216.html
+}
+
+function Get-DetectJar ($DetectFolder, $DetectSource, $DetectVersionKey, $DetectVersion, $ProxyInfo) {
+    $LastDownloadFile = "$DetectFolder/detect-last-downloaded-jar.txt"
+
+    if ($DetectSource -eq "") {
+        if ($DetectVersion -eq "") {
+            $DetectVersionUrl = "https://repo.blackduck.com/api/storage/bds-integrations-release/com/blackduck/integration/detect?properties=" + $DetectVersionKey
+            $DetectSource = Receive-DetectSource -ProxyInfo $ProxyInfo -DetectVersionUrl $DetectVersionUrl -DetectVersionKey $DetectVersionKey
+        }
+        else {
+            $DetectSource = "https://repo.blackduck.com/bds-integrations-release/com/blackduck/integration/detect/" + $DetectVersion + "/detect-" + $DetectVersion + ".jar"
+        }
+    }
+
+    if ($DetectSource) {
+        Write-Host "Using Detect source $DetectSource"
+
+        $DetectFileName = Parse-Detect-File-Name -DetectSource $DetectSource
+
+        $DetectJarFile = "$DetectFolder/$DetectFileName"
+    } else {
+        Write-Host "Unable to find Detect Source, will attempt to find a last downloaded detect."
+
+        $LastDownloadFileExists = Test-Path $LastDownloadFile
+        Write-Host "Last download exists '$LastDownloadFileExists'"
+
+        if ($LastDownloadFileExists) {
+            $DetectJarFile = Get-Content -Path $LastDownloadFile
+            Write-Host "Using last downloaded detect '$DetectJarFile'"
+        } else {
+            Write-Host "Unable to determine detect version and no downloaded detect found."
+            exit -1
+        }
+    }
+
+
+    $DetectJarExists = Test-Path $DetectJarFile
+    Write-Host "Detect jar exists '$DetectJarExists'"
+
+    if (!$DetectJarExists) {
+        Receive-DetectJar -DetectUrl $DetectSource -DetectJarFile $DetectJarFile -ProxyInfo $ProxyInfo -LastDownloadFile $LastDownloadFile
+    }
+    else {
+        Write-Host "You have already downloaded the latest file, so the local file will be used."
+    }
+
+    return $DetectJarFile
+}
+
+function Parse-Detect-File-Name($DetectSource) {
+    $SlashParts = $DetectSource.Split("/")
+    $LastPart = $SlashParts[$SlashParts.Length - 1]
+    return $LastPart
+}
+
+function Invoke-Detect ($DetectJarFile, $DetectArgs) {
+    ${Env:detect.phone.home.passthrough.powershell.version} = $Version
+    $JavaArgs = @("-jar", $DetectJarFile)
+    $AllArgs = $JavaArgs + $DetectArgs
+    Set-ToEscaped($AllArgs)
+    Write-Host "Running Detect: $AllArgs"
+    $JavaCommand = Determine-Java($JavaHome, $DetectJavaPath)
+    $DetectProcess = Start-Process $JavaCommand -ArgumentList $AllArgs -NoNewWindow -PassThru
+    Wait-Process -InputObject $DetectProcess -ErrorAction SilentlyContinue
+    $DetectExitCode = $DetectProcess.ExitCode;
+    Write-Host "Result code of $DetectExitCode, exiting"
+    return $DetectExitCode
+}
+
+function Determine-Java ($EnvJavaHome, $EnvDetectJavaPath) {
+    $JavaCommand = "java"
+    if ($DetectJavaPath -ne "") {
+        $JavaCommand = $DetectJavaPath
+        Write-Host "Java Source: DETECT_JAVA_PATH=$JavaCommand"
+    } elseif ($JavaHome -ne "") {
+        $JavaCommand = "$JavaHome/bin/java"
+        Write-Host "Java Source: JAVA_HOME/bin/java=$JavaCommand"
+    } else {
+        Write-Host "Java Source: PATH"
+    }
+
+    return $JavaCommand
+}
+
+function Initialize-DetectFolder ($DetectFolder, $TempFolder, $HomeTempFolder) {
+    if ($DetectFolder -ne "") {
+        Write-Host "Using supplied Detect folder: $DetectFolder"
+        return Initialize-Folder -Folder $DetectFolder
+    }
+
+    if ($TempFolder -ne "") {
+        Write-Host "Using system temp folder: $TempFolder"
+        return Initialize-Folder -Folder $TempFolder
+    }
+
+    return Initialize-Folder -Folder $HomeTempFolder
+}
+
+function Initialize-Folder ($Folder) {
+    If (!(Test-Path $Folder)) {
+        Write-Host "Created folder: $Folder"
+        New-Item -ItemType Directory -Force -Path $Folder | Out-Null #Pipe to Out-Null to prevent dirtying to the function output
+    }
+    return $Folder
+}
+
+function Receive-DetectSource ($ProxyInfo, $DetectVersionUrl, $DetectVersionKey) {
+    Write-Host "Finding latest Detect version."
+    $DetectVersionData = Invoke-WebRequestWrapper -Url $DetectVersionUrl -ProxyInfo $ProxyInfo
+    if (!$DetectVersionData){
+        Write-Host "Failed to get detect version"
+        return $null
+    }
+
+    $DetectVersionJson = ConvertFrom-Json -InputObject $DetectVersionData
+
+    $Properties = $DetectVersionJson | select -ExpandProperty "properties"
+    $DetectVersionUrl = $Properties | select -ExpandProperty $DetectVersionKey
+    return $DetectVersionUrl
+}
+
+function Receive-DetectJar ($DetectUrl, $DetectJarFile, $LastDownloadFile, $ProxyInfo) {
+    Write-Host "You don't have Detect. Downloading now."
+    Write-Host "Using url $DetectUrl"
+    $DetectJarTempFile = "$DetectJarFile.tmp"
+    $Request = Invoke-WebRequestWrapper -Url $DetectUrl -DownloadLocation $DetectJarTempFile -ProxyInfo $ProxyInfo
+    Rename-Item -Path $DetectJarTempFile -NewName $DetectJarFile
+    $DetectJarExists = Test-Path $DetectJarFile
+    Write-Host "Downloaded Detect jar successfully '$DetectJarExists'"
+    Set-Content -Value $DetectJarFile -Path $LastDownloadFile
+}
+
+function Set-ToEscaped ($ArgArray) {
+    for ($i = 0; $i -lt $ArgArray.Count ; $i++) {
+        $Value = $ArgArray[$i]
+        $ArgArray[$i] = """$Value"""
+    }
+}
+
+function Test-JavaNotAvailable() {
+    Write-Host "Checking if Java is installed by asking for version."
+    try {
+        $ProcessStartInfo = New-object System.Diagnostics.ProcessStartInfo
+        $ProcessStartInfo.CreateNoWindow = $true
+        $ProcessStartInfo.UseShellExecute = $false
+        $ProcessStartInfo.RedirectStandardOutput = $true
+        $ProcessStartInfo.RedirectStandardError = $true
+        $ProcessStartInfo.FileName = Determine-Java($JavaHome, $DetectJavaPath)
+        $ProcessStartInfo.Arguments = @("-version")
+        $Process = New-Object System.Diagnostics.Process
+        $Process.StartInfo = $ProcessStartInfo
+        [void]$Process.Start()
+        $StdOutput = $process.StandardOutput.ReadToEnd()
+        $StdError = $process.StandardError.ReadToEnd()
+        $Process.WaitForExit()
+        Write-Host "Java Standard Output: $StdOutput"
+        Write-Host "Java Error Output: $StdError"
+        Write-Host "Successfully able to start java and get version."
+        return $FALSE;
+    }
+    catch {
+        Write-Host "An error occurred checking the Java version. Please ensure Java is installed."
+        return $TRUE;
+    }
+}