Downloads:

10,796

Downloads of v 0.0.1:

596

Last Update:

19 Jul 2018

Package Maintainer(s):

Software Author(s):

  • Bill Curran

Tags:

bcurran3 unofficial choco pre installer uninstaller checks extension

Chocolatey Preinstaller Checks Extension

This is not the latest version of Chocolatey Preinstaller Checks Extension available.

  • 1
  • 2
  • 3

0.0.1 | Updated: 19 Jul 2018

Downloads:

10,796

Downloads of v 0.0.1:

596

Maintainer(s):

Software Author(s):

  • Bill Curran

  • 1
  • 2
  • 3
Chocolatey Preinstaller Checks Extension 0.0.1

This is not the latest version of Chocolatey Preinstaller Checks Extension available.

  • 1
  • 2
  • 3

Some Checks Have Failed or Are Not Yet Complete

Not All Tests Have Passed


Validation Testing Passed


Verification Testing Passed

Details

Scan Testing Resulted in Investigate

Details
Learn More

Deployment Method: Individual Install, Upgrade, & Uninstall

To install Chocolatey Preinstaller Checks Extension, run the following command from the command line or from PowerShell:

>

To upgrade Chocolatey Preinstaller Checks Extension, run the following command from the command line or from PowerShell:

>

To uninstall Chocolatey Preinstaller Checks Extension, run the following command from the command line or from PowerShell:

>

Deployment Method:

📝 NOTE: This applies to both open source and commercial editions of Chocolatey.

1. Enter Your Internal Repository Url

(this should look similar to https://community.chocolatey.org/api/v2/)


2. Setup Your Environment

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

2. Get the package into your environment

  • Open Source or Commercial:
    • Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://community.chocolatey.org/api/v2/. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
    • You can also just download the package and push it to a repository Download

3. Copy Your Script

choco upgrade chocolatey-preinstaller-checks.extension -y --source="'INTERNAL REPO URL'" --version="'0.0.1'" [other options]

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:


choco upgrade chocolatey-preinstaller-checks.extension -y --source="'INTERNAL REPO URL'" --version="'0.0.1'" 
$exitCode = $LASTEXITCODE

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0
}

Exit $exitCode

- name: Install chocolatey-preinstaller-checks.extension
  win_chocolatey:
    name: chocolatey-preinstaller-checks.extension
    version: '0.0.1'
    source: INTERNAL REPO URL
    state: present

See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.


chocolatey_package 'chocolatey-preinstaller-checks.extension' do
  action    :install
  source   'INTERNAL REPO URL'
  version  '0.0.1'
end

See docs at https://docs.chef.io/resource_chocolatey_package.html.


cChocoPackageInstaller chocolatey-preinstaller-checks.extension
{
    Name     = "chocolatey-preinstaller-checks.extension"
    Version  = "0.0.1"
    Source   = "INTERNAL REPO URL"
}

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.


package { 'chocolatey-preinstaller-checks.extension':
  ensure   => '0.0.1',
  provider => 'chocolatey',
  source   => 'INTERNAL REPO URL',
}

Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.


4. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

This package is exempt from moderation. While it is likely safe for you, there is more risk involved.
Description

Screenshot of chocolatey-preinstaller-checks.extension

Chocolatey Preinstaller Checks Extension is a Chocolatey extension that intercepts and runs checks before installing or uninstalling a program. This extension will start working automatically once installed and does NOT need to be implemented by package creators/maintainers. Chocolatey Preinstaller Checks Extension is meant to be installed and used directly by Chocolatey end users.

PURPOSE:

This extension attempts to head off problems related to:

Chocolatey Preinstaller Checks Extension's main purpose is to fend off specific types of problems before they occur. Currently Chocolatey (choco.exe) is not multi-instance friendly. If you try to install or uninstall packages using choco.exe in two Command Prompts at the same time, strange (bad) things may occur. Chocolatey Preinstaller Checks Extension avoids these strange (bad) things by intercepting calls to install and uninstall programs and making the current choco.exe instance wait for previous instances to finish. Chocolatey Preinstaller Checks Extension also checks Windows Installer to see if it's busy and will make MSI installer and uninstaller programs wait until Windows Installer has finished processing the other program. Chocolatey Preinstaller Checks Extension will pause and retry until commandExecutionTimeoutSeconds hits it's threshold and then choco will abort. Chocolatey Preinstaller Checks Extension only runs before PROGRAM installations and uninstallations. It does not perform any functions related to portable packages or other choco commands.

FEATURES:

  • Chocolatey Preinstaller Checks Extension will check if there is a pending reboot and warn you about it if so.
  • Chocolatey Preinstaller Checks Extension will check if Windows Installer is already running and wait for it to finish.
  • Chocolatey Preinstaller Checks Extension will check if there are instances of choco.exe already running and wait for them to finish.

PACKAGE NOTES


Click here to Patreon-ize the package maintainer.



extensions\Chocolatey-Preinstaller-Checks.extension.psm1
$scriptRoot = Split-Path -Path $MyInvocation.MyCommand.Definition
 
$publicFunctions = @(
    'Get-chocoCounts',
	'Get-chocoStatus',
	'Get-PendingRebootStatus',
    'Get-WindowsInstallerStatus',
	'Start-PreinstallChecks',
	'Start-PreuninstallChecks'
)

Get-ChildItem -Path "$scriptRoot\*.ps1" | ForEach-Object { . $_ }
Export-ModuleMember -Function $publicFunctions

Set-Alias Install-ChocolateyInstallPackage Start-PreinstallChecks -Force -Scope Global
Set-Alias Uninstall-ChocolateyPackage Start-PreuninstallChecks -Force -Scope Global
extensions\Get-chocoCounts.ps1
# chocolatey-preinstaller-checks.extension by Bill Curran AKA BCURRAN3 - 2018 public domain
# get instances of choco.exe and all shims 
# \ProgramData\chocolatey\bin\choco.exe (in path) IS a shim to \ProgramData\chocolatey\choco.exe actual (not in path)
# i.e. running choco.exe will always count as 2 instances
# all shims run choco.exe, so choco.exe count is +1 from the shim execution

function Get-chocoCounts{
$chocoInstances      = @(Get-Process -ea silentlycontinue choco).count #includes choco.exe shim
$chocolateyInstances = @(Get-Process -ea silentlycontinue chocolatey).count
$cinstInstances      = @(Get-Process -ea silentlycontinue cinst).count
$clistInstances      = @(Get-Process -ea silentlycontinue clist).count
$cpackInstances      = @(Get-Process -ea silentlycontinue cpack).count
$cpushInstances      = @(Get-Process -ea silentlycontinue cpush).count
$cuninstInstances    = @(Get-Process -ea silentlycontinue cuninst).count
$cupInstances        = @(Get-Process -ea silentlycontinue cup).count
$cverInstances       = @(Get-Process -ea silentlycontinue cver).count
# add shims to false choco.exe count
$chocoInstances = ($chocoInstances +$chocolateyInstances +$cinstInstances +$clistInstances +$cpackInstances +$cpushInstances +$cuninstInstances +$cupInstances +$cverInstances)
# divide in half to remove shims from count and get real choco.exe instance count
$chocoInstances = $chocoInstances/2
return $chocoInstances
}
extensions\Get-chocoStatus.ps1
# chocolatey-preinstaller-checks.extension by Bill Curran AKA BCURRAN3 - 2018 public domain
# Supposedly choco-agent reports as choco.exe?? per gep13. Unknown, can't test but doesn't make sense.

function Get-chocoStatus{

if((get-process "chocolatey-agent" -ea SilentlyContinue) -eq $Null){
    } else {
    Write-Host "  * chocolatey-agent.exe found running, possibly can't check for multiple instances at this time. (Sorry!) " -foreground yellow
	break
  }

$chocoInstances = (Get-chocoCounts)

if ($chocoInstances -ge 2)
    {
     while ($chocoInstances -gt 1)
     {
	  # exclude current instance from status report
      $chocoInstances = $chocoInstances-1
      Write-Host "  * WARNING: $chocoInstances other instance(s) of choco.exe actual found running. Pausing 30 seconds..." -foreground red
	  Start-Sleep -seconds 30
      $chocoInstances = (Get-chocoCounts)
     }
	} else {
	  Write-Host "  * choco.exe IS NOT running multiple instances." -foreground green
	 }
}
extensions\Get-PendingRebootStatus.ps1
# chocolatey-preinstaller-checks.extension by Bill Curran AKA BCURRAN3 - 2018 public domain
# thanks to http://ilovepowershell.com/2015/09/10/how-to-check-if-a-server-needs-a-reboot/

function Get-PendingRebootStatus{

$RebootStatus=$false
if (Get-ItemProperty -Path "HKLM:\Software\Microsoft\Windows\CurrentVersion\Component Based Servicing\RebootPending" -ErrorAction SilentlyContinue) { $RebootStatus=$true }
if (Get-ItemProperty -Path "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\WindowsUpdate\Auto Update\RebootRequired" -ErrorAction SilentlyContinue) { $RebootStatus=$true }
if (Get-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\Session Manager" -Name PendingFileRenameOperations -ErrorAction SilentlyContinue) { $RebootStatus=$true }
 try { 
   $util = [wmiclass]"\\.\root\ccm\clientsdk:CCM_ClientUtilities"
   $status = $util.DetermineIfRebootPending()
   if(($status -ne $null) -and $status.RebootPending){
     RebootStatus=$true
   }
 }catch{}

if ($RebootStatus -eq $true){
     Write-Host "  * WARNING: Pending reboot found." -foreground red 
   } else {
     Write-Host "  * Pending reboot NOT found." -foreground green
   }
}
extensions\Get-WindowsInstallerStatus.ps1
# chocolatey-preinstaller-checks.extension by Bill Curran AKA BCURRAN3 - 2018 public domain

function Get-WindowsInstallerStatus{
$msiexecInstances = @(Get-Process -ea silentlycontinue msiexec).count

if ($msiexecInstances -gt 1)
   {
    while ($msiexecInstances -gt 1)
	{
     Write-Host "  * WARNING: Windows Installer IS currently running. Pausing 30 seconds..." -foreground red
	 Start-Sleep -seconds 30
     $msiexecInstances = @(Get-Process -ea silentlycontinue msiexec).count
	}
   }
Write-Host "  * Windows Installer IS NOT currently running" -foreground green
}

extensions\Start-PreinstallChecks.ps1
# chocolatey-preinstaller-checks.extension by Bill Curran AKA BCURRAN3 - 2018 public domain
# This function is aliased as Install-ChocolateyInstallPackage to intercept and run before Install-ChocolateyInstallPackage

function Start-PreInstallChecks{
$CheckLicense = "$env:ChocolateyInstall\license\chocolatey.license.xml"

Write-Host "PRE-INSTALLATION CHECKS:" -foreground magenta
Get-PendingRebootStatus
Get-WindowsInstallerStatus
Get-chocoStatus

# Remove alias for normal operations and call Install-ChocolateyInstallPackage actual
Remove-Item alias:\Install-ChocolateyInstallPackage 
if ($env:ChocolateyLicenseValid -eq 'true') {
    Set-Alias Install-ChocolateyInstallPackage Install-ChocolateyInstallPackageCmdlet -Force -Scope Global
   }
Install-ChocolateyInstallPackage @args
}
extensions\Start-PreuninstallChecks.ps1
# chocolatey-preinstaller-checks.extension by Bill Curran AKA BCURRAN3 - 2018 public domain
# This function is aliased as Uninstall-ChocolateyPackage to intercept and run before Uninstall-ChocolateyPackage

function Start-PreuninstallChecks{
Write-Host "PRE-UNINSTALLATION CHECKS:" -foreground magenta
Get-PendingRebootStatus
Get-WindowsInstallerStatus
Get-chocoStatus

# Remove alias for normal operations and call Uninstall-ChocolateyPackage actual
Remove-Item alias:\Uninstall-ChocolateyPackage
Uninstall-ChocolateyPackage @args
}

Log in or click on link to see number of positives.

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Add to Builder Version Downloads Last Updated Status
Chocolatey Preinstaller Checks Extension 0.0.2.1 6896 Friday, February 22, 2019 Exempted
Chocolatey Preinstaller Checks Extension 0.0.2 621 Friday, November 23, 2018 Exempted
Chocolatey Preinstaller Checks Extension 0.0.1 596 Thursday, July 19, 2018 Exempted

  • The choco multi-instance checking is supposedly NOT compatible with the Chocolatey licensed self service agent as it supposedly runs choco.exe all the time.
  • If two instances of choco.exe run within 30 seconds of each other, they will most likely loop forever or at least until commandExecutionTimeoutSeconds.
  • Aborting a program package install/uninstall due to "* WARNING: x other instance(s) of choco.exe actual found running. Pausing 30 seconds..." will result in Chocolatey "loosing" the package, i.e. "[Pending] Removing incomplete install for 'packagename'" on next run. The result is the same if you have this extension or not and defeats the purpose of this extension.

CHANGE LOG:

  • 0.0.1 - initial release

ROADMAP:

  • Check for the Chocolatey self service agent and handle differently if what I'm told is true.
  • Possibly add configurable options to enable disable each of the three checks.
  • Probably add configurable timeouts for each of the three checks.
  • Possibly add conditional handling options for each of the three checks, i.e. option to abort install based on condition.

You can add your options/wants/recommendations to https://github.com/bcurran3/ChocolateyPackages/issues/27


This package has no dependencies.

Discussion for the Chocolatey Preinstaller Checks Extension Package

Ground Rules:

  • This discussion is only about Chocolatey Preinstaller Checks Extension and the Chocolatey Preinstaller Checks Extension package. If you have feedback for Chocolatey, please contact the Google Group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or Chocolatey Preinstaller Checks Extension, or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.
comments powered by Disqus