From 12f96e6692065580092d91bacfa48e0eade186d2 Mon Sep 17 00:00:00 2001 From: manu Date: Fri, 7 Jan 2022 16:47:50 +0100 Subject: [PATCH] (misc) Create chocolatey package --- chocolatey/ReadMe.md | 134 +++++++++++++ chocolatey/choria.nuspec | 90 +++++++++ chocolatey/tools/LICENSE.txt | 205 ++++++++++++++++++++ chocolatey/tools/VERIFICATION.txt | 4 + chocolatey/tools/chocolateybeforemodify.ps1 | 9 + chocolatey/tools/chocolateyinstall.ps1 | 153 +++++++++++++++ chocolatey/tools/chocolateyuninstall.ps1 | 83 ++++++++ 7 files changed, 678 insertions(+) create mode 100644 chocolatey/ReadMe.md create mode 100644 chocolatey/choria.nuspec create mode 100644 chocolatey/tools/LICENSE.txt create mode 100644 chocolatey/tools/VERIFICATION.txt create mode 100644 chocolatey/tools/chocolateybeforemodify.ps1 create mode 100644 chocolatey/tools/chocolateyinstall.ps1 create mode 100644 chocolatey/tools/chocolateyuninstall.ps1 diff --git a/chocolatey/ReadMe.md b/chocolatey/ReadMe.md new file mode 100644 index 000000000..d87e97db9 --- /dev/null +++ b/chocolatey/ReadMe.md @@ -0,0 +1,134 @@ +## Summary +How do I create packages? See https://docs.chocolatey.org/en-us/create/create-packages + +If you are submitting packages to the community feed (https://community.chocolatey.org) +always try to ensure you have read, understood and adhere to the create +packages wiki link above. + +## Automatic Packaging Updates? +Consider making this package an automatic package, for the best +maintainability over time. Read up at https://docs.chocolatey.org/en-us/create/automatic-packages + +## Shim Generation +Any executables you include in the package or download (but don't call +install against using the built-in functions) will be automatically shimmed. + +This means those executables will automatically be included on the path. +Shim generation runs whether the package is self-contained or uses automation +scripts. + +By default, these are considered console applications. + +If the application is a GUI, you should create an empty file next to the exe +named 'name.exe.gui' e.g. 'bob.exe' would need a file named 'bob.exe.gui'. +See https://docs.chocolatey.org/en-us/create/create-packages#how-do-i-set-up-shims-for-applications-that-have-a-gui + +If you want to ignore the executable, create an empty file next to the exe +named 'name.exe.ignore' e.g. 'bob.exe' would need a file named +'bob.exe.ignore'. +See https://docs.chocolatey.org/en-us/create/create-packages#how-do-i-exclude-executables-from-getting-shims + +## Self-Contained? +If you have a self-contained package, you can remove the automation scripts +entirely and just include the executables, they will automatically get shimmed, +which puts them on the path. Ensure you have the legal right to distribute +the application though. See https://docs.chocolatey.org/en-us/information/legal. + +You should read up on the Shim Generation section to familiarize yourself +on what to do with GUI applications and/or ignoring shims. + +## Automation Scripts +You have a powerful use of Chocolatey, as you are using PowerShell. So you +can do just about anything you need. Choco has some very handy built-in +functions that you can use, these are sometimes called the helpers. + +### Built-In Functions +https://docs.chocolatey.org/en-us/create/functions + +A note about a couple: +* Get-BinRoot - this is a horribly named function that doesn't do what new folks think it does. It gets you the 'tools' root, which by default is set to 'c:\tools', not the chocolateyInstall bin folder - see https://docs.chocolatey.org/en-us/create/functions/get-toolslocation +* Install-BinFile - used for non-exe files - executables are automatically shimmed... - see https://docs.chocolatey.org/en-us/create/functions/install-binfile +* Uninstall-BinFile - used for non-exe files - executables are automatically shimmed - see https://docs.chocolatey.org/en-us/create/functions/uninstall-binfile + +### Getting package specific information +Use the package parameters pattern - see https://docs.chocolatey.org/en-us/guides/create/parse-packageparameters-argument + +### Need to mount an ISO? +https://docs.chocolatey.org/en-us/guides/create/mount-an-iso-in-chocolatey-package + +### Environment Variables +Chocolatey makes a number of environment variables available (You can access any of these with $env:TheVariableNameBelow): + + * TEMP/TMP - Overridden to the CacheLocation, but may be the same as the original TEMP folder + * ChocolateyInstall - Top level folder where Chocolatey is installed + * ChocolateyPackageName - The name of the package, equivalent to the `` field in the nuspec (0.9.9+) + * ChocolateyPackageTitle - The title of the package, equivalent to the `` field in the nuspec (0.10.1+) + * ChocolateyPackageVersion - The version of the package, equivalent to the `<version />` field in the nuspec (0.9.9+) + * ChocolateyPackageFolder - The top level location of the package folder - the folder where Chocolatey has downloaded and extracted the NuGet package, typically `C:\ProgramData\chocolatey\lib\packageName`. + +#### Advanced Environment Variables +The following are more advanced settings: + + * ChocolateyPackageParameters - Parameters to use with packaging, not the same as install arguments (which are passed directly to the native installer). Based on `--package-parameters`. (0.9.8.22+) + * CHOCOLATEY_VERSION - The version of Choco you normally see. Use if you are 'lighting' things up based on choco version. (0.9.9+) - Otherwise take a dependency on the specific version you need. + * ChocolateyForceX86 = If available and set to 'true', then user has requested 32bit version. (0.9.9+) - Automatically handled in built in Choco functions. + * OS_PLATFORM - Like Windows, OSX, Linux. (0.9.9+) + * OS_VERSION - The version of OS, like 6.1 something something for Windows. (0.9.9+) + * OS_NAME - The reported name of the OS. (0.9.9+) + * USER_NAME = The user name (0.10.6+) + * USER_DOMAIN = The user domain name (could also be local computer name) (0.10.6+) + * IS_PROCESSELEVATED = Is the process elevated? (0.9.9+) + * IS_SYSTEM = Is the user the system account? (0.10.6+) + * IS_REMOTEDESKTOP = Is the user in a terminal services session? (0.10.6+) + * ChocolateyToolsLocation - formerly 'ChocolateyBinRoot' ('ChocolateyBinRoot' will be removed with Chocolatey v2.0.0), this is where tools being installed outside of Chocolatey packaging will go. (0.9.10+) + +#### Set By Options and Configuration +Some environment variables are set based on options that are passed, configuration and/or features that are turned on: + + * ChocolateyEnvironmentDebug - Was `--debug` passed? If using the built-in PowerShell host, this is always true (but only logs debug messages to console if `--debug` was passed) (0.9.10+) + * ChocolateyEnvironmentVerbose - Was `--verbose` passed? If using the built-in PowerShell host, this is always true (but only logs verbose messages to console if `--verbose` was passed). (0.9.10+) + * ChocolateyExitOnRebootDetected - Are we exiting on a detected reboot? Set by ` --exit-when-reboot-detected` or the feature `exitOnRebootDetected` (0.10.16+) + * ChocolateyForce - Was `--force` passed? (0.9.10+) + * ChocolateyForceX86 - Was `-x86` passed? (CHECK) + * ChocolateyRequestTimeout - How long before a web request will time out. Set by config `webRequestTimeoutSeconds` (CHECK) + * ChocolateyResponseTimeout - How long to wait for a download to complete? Set by config `commandExecutionTimeoutSeconds` (CHECK) + * ChocolateyPowerShellHost - Are we using the built-in PowerShell host? Set by `--use-system-powershell` or the feature `powershellHost` (0.9.10+) + +#### Business Edition Variables + + * ChocolateyInstallArgumentsSensitive - Encrypted arguments passed from command line `--install-arguments-sensitive` that are not logged anywhere. (0.10.1+ and licensed editions 1.6.0+) + * ChocolateyPackageParametersSensitive - Package parameters passed from command line `--package-parameters-senstivite` that are not logged anywhere. (0.10.1+ and licensed editions 1.6.0+) + * ChocolateyLicensedVersion - What version is the licensed edition on? + * ChocolateyLicenseType - What edition / type of the licensed edition is installed? + * USER_CONTEXT - The original user context - different when self-service is used (Licensed v1.10.0+) + +#### Experimental Environment Variables +The following are experimental or use not recommended: + + * OS_IS64BIT = This may not return correctly - it may depend on the process the app is running under (0.9.9+) + * CHOCOLATEY_VERSION_PRODUCT = the version of Choco that may match CHOCOLATEY_VERSION but may be different (0.9.9+) - based on git describe + * IS_ADMIN = Is the user an administrator? But doesn't tell you if the process is elevated. (0.9.9+) + * IS_REMOTE = Is the user in a remote session? (0.10.6+) + +#### Not Useful Or Anti-Pattern If Used + + * ChocolateyInstallOverride = Not for use in package automation scripts. Based on `--override-arguments` being passed. (0.9.9+) + * ChocolateyInstallArguments = The installer arguments meant for the native installer. You should use chocolateyPackageParameters instead. Based on `--install-arguments` being passed. (0.9.9+) + * ChocolateyIgnoreChecksums - Was `--ignore-checksums` passed or the feature `checksumFiles` turned off? (0.9.9.9+) + * ChocolateyAllowEmptyChecksums - Was `--allow-empty-checksums` passed or the feature `allowEmptyChecksums` turned on? (0.10.0+) + * ChocolateyAllowEmptyChecksumsSecure - Was `--allow-empty-checksums-secure` passed or the feature `allowEmptyChecksumsSecure` turned on? (0.10.0+) + * ChocolateyCheckLastExitCode - Should Chocolatey check LASTEXITCODE? Is the feature `scriptsCheckLastExitCode` turned on? (0.10.3+) + * ChocolateyChecksum32 - Was `--download-checksum` passed? (0.10.0+) + * ChocolateyChecksumType32 - Was `--download-checksum-type` passed? (0.10.0+) + * ChocolateyChecksum64 - Was `--download-checksum-x64` passed? (0.10.0)+ + * ChocolateyChecksumType64 - Was `--download-checksum-type-x64` passed? (0.10.0)+ + * ChocolateyPackageExitCode - The exit code of the script that just ran - usually set by `Set-PowerShellExitCode` (CHECK) + * ChocolateyLastPathUpdate - Set by Chocolatey as part of install, but not used for anything in particular in packaging. + * ChocolateyProxyLocation - The explicit proxy location as set in the configuration `proxy` (0.9.9.9+) + * ChocolateyDownloadCache - Use available download cache? Set by `--skip-download-cache`, `--use-download-cache`, or feature `downloadCache` (0.9.10+ and licensed editions 1.1.0+) + * ChocolateyProxyBypassList - Explicitly set locations to ignore in configuration `proxyBypassList` (0.10.4+) + * ChocolateyProxyBypassOnLocal - Should the proxy bypass on local connections? Set based on configuration `proxyBypassOnLocal` (0.10.4+) + * http_proxy - Set by original `http_proxy` passthrough, or same as `ChocolateyProxyLocation` if explicitly set. (0.10.4+) + * https_proxy - Set by original `https_proxy` passthrough, or same as `ChocolateyProxyLocation` if explicitly set. (0.10.4+) + * no_proxy- Set by original `no_proxy` passthrough, or same as `ChocolateyProxyBypassList` if explicitly set. (0.10.4+) + diff --git a/chocolatey/choria.nuspec b/chocolatey/choria.nuspec new file mode 100644 index 000000000..f0aea6e57 --- /dev/null +++ b/chocolatey/choria.nuspec @@ -0,0 +1,90 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Read this before creating packages: https://docs.chocolatey.org/en-us/create/create-packages --> +<!-- It is especially important to read the above link to understand additional requirements when publishing packages to the community feed aka dot org (https://community.chocolatey.org/packages). --> + +<!-- Test your packages in a test environment: https://github.com/chocolatey/chocolatey-test-environment --> + +<!-- +This is a nuspec. It mostly adheres to https://docs.nuget.org/create/Nuspec-Reference. Chocolatey uses a special version of NuGet.Core that allows us to do more than was initially possible. As such there are certain things to be aware of: + +* the package xmlns schema url may cause issues with nuget.exe +* Any of the following elements can ONLY be used by choco tools - projectSourceUrl, docsUrl, mailingListUrl, bugTrackerUrl, packageSourceUrl, provides, conflicts, replaces +* nuget.exe can still install packages with those elements but they are ignored. Any authoring tools or commands will error on those elements +--> + +<!-- You can embed software files directly into packages, as long as you are not bound by distribution rights. --> +<!-- * If you are an organization making private packages, you probably have no issues here --> +<!-- * If you are releasing to the community feed, you need to consider distribution rights. --> +<!-- Do not remove this test for UTF-8: if “Ω” doesn’t appear as greek uppercase omega letter enclosed in quotation marks, you should use an editor that supports UTF-8, not this one. --> +<package xmlns="http://schemas.microsoft.com/packaging/2015/06/nuspec.xsd"> + <metadata> + <!-- == PACKAGE SPECIFIC SECTION == --> + <!-- This section is about this package, although id and version have ties back to the software --> + <!-- id is lowercase and if you want a good separator for words, use '-', not '.'. Dots are only acceptable as suffixes for certain types of packages, e.g. .install, .portable, .extension, .template --> + <!-- If the software is cross-platform, attempt to use the same id as the debian/rpm package(s) if possible. --> + <id>choria</id> + <!-- version should MATCH as closely as possible with the underlying software --> + <!-- Is the version a prerelease of a version? https://docs.nuget.org/create/versioning#creating-prerelease-packages --> + <!-- Note that unstable versions like 0.0.1 can be considered a released version, but it's possible that one can release a 0.0.1-beta before you release a 0.0.1 version. If the version number is final, that is considered a released version and not a prerelease. --> + <version>0.24.1</version> + <!-- <packageSourceUrl>Where is this Chocolatey package located (think GitHub)? packageSourceUrl is highly recommended for the community feed</packageSourceUrl>--> + <!-- owners is a poor name for maintainers of the package. It sticks around by this name for compatibility reasons. It basically means you. --> + <!--<owners>__REPLACE_YOUR_NAME__</owners>--> + <!-- ============================== --> + + <!-- == SOFTWARE SPECIFIC SECTION == --> + <!-- This section is about the software itself --> + <title>Choria + R.I.Pienaar + + https://choria.io + + + https://choria.io/Choria-logo-horizontal-color-on-blue.svg + + + https://github.com/choria-io/go-choria/blob/main/LICENSE + false + https://github.com/choria-io/go-choria/ + https://choria.io/docs/about/ + + https://github.com/choria-io/go-choria/issues + choria orchestration puppet + Choria Broker and Server + + Choria is a framework for building Control Planes, Orchestration Systems and Programmable Infrastructure. + + This is a daemon and related tools written in Go that hosts services, autonomous agents and generally provide a secure hosting environment for callable logic that you can interact with from code. + + Additionally, this is the foundational technology for a monitoring pipeline called Choria Scout. + + More information about the project can be found on [Choria.IO](https://choria.io). + + + + + + + + + + + + + + + + + + diff --git a/chocolatey/tools/LICENSE.txt b/chocolatey/tools/LICENSE.txt new file mode 100644 index 000000000..7ee4a7fac --- /dev/null +++ b/chocolatey/tools/LICENSE.txt @@ -0,0 +1,205 @@ +From: https://github.com/choria-io/go-choria/blob/main/LICENSE + + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/chocolatey/tools/VERIFICATION.txt b/chocolatey/tools/VERIFICATION.txt new file mode 100644 index 000000000..e31b9ced8 --- /dev/null +++ b/chocolatey/tools/VERIFICATION.txt @@ -0,0 +1,4 @@ +VERIFICATION + +Head to https://github.com/choria-io/go-choria/releases/tag/v0.24.1, +download `Choria-0.24.1.msi` and create its checksum. \ No newline at end of file diff --git a/chocolatey/tools/chocolateybeforemodify.ps1 b/chocolatey/tools/chocolateybeforemodify.ps1 new file mode 100644 index 000000000..9588ffe80 --- /dev/null +++ b/chocolatey/tools/chocolateybeforemodify.ps1 @@ -0,0 +1,9 @@ +# This runs in 0.9.10+ before upgrade and uninstall. +# Use this file to do things like stop services prior to upgrade or uninstall. +# NOTE: It is an anti-pattern to call chocolateyUninstall.ps1 from here. If you +# need to uninstall an MSI prior to upgrade, put the functionality in this +# file without calling the uninstall script. Make it idempotent in the +# uninstall script so that it doesn't fail when it is already uninstalled. +# NOTE: For upgrades - like the uninstall script, this script always runs from +# the currently installed version, not from the new upgraded package version. + diff --git a/chocolatey/tools/chocolateyinstall.ps1 b/chocolatey/tools/chocolateyinstall.ps1 new file mode 100644 index 000000000..08c1e5543 --- /dev/null +++ b/chocolatey/tools/chocolateyinstall.ps1 @@ -0,0 +1,153 @@ +# IMPORTANT: Before releasing this package, copy/paste the next 2 lines into PowerShell to remove all comments from this file: +# $f='c:\path\to\thisFile.ps1' +# gc $f | ? {$_ -notmatch "^\s*#"} | % {$_ -replace '(^.*?)\s*?[^``]#.*','$1'} | Out-File $f+".~" -en utf8; mv -fo $f+".~" $f + +# 1. See the _TODO.md that is generated top level and read through that +# 2. Follow the documentation below to learn how to create a package for the package type you are creating. +# 3. In Chocolatey scripts, ALWAYS use absolute paths - $toolsDir gets you to the package's tools directory. +$ErrorActionPreference = 'Stop'; # stop on all errors +$toolsDir = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)" +# Internal packages (organizations) or software that has redistribution rights (community repo) +# - Use `Install-ChocolateyInstallPackage` instead of `Install-ChocolateyPackage` +# and put the binaries directly into the tools folder (we call it embedding) +$fileLocation = Join-Path $toolsDir 'Choria-0.24.1.msi' +# If embedding binaries increase total nupkg size to over 1GB, use share location or download from urls +#$fileLocation = '\\SHARE_LOCATION\to\INSTALLER_FILE' +# Community Repo: Use official urls for non-redist binaries or redist where total package size is over 200MB +# Internal/Organization: Download from internal location (internet sources are unreliable) +$url='' +$url64 = 'https://github.com/choria-io/go-choria/releases/download/v0.24.1/Choria-0.24.1.msi' # 64bit URL here (HTTPS preferred) or remove - if installer contains both (very rare), use $url + +$packageArgs = @{ + packageName = $env:ChocolateyPackageName + unzipLocation = $toolsDir + fileType = 'msi' #only one of these: exe, msi, msu + #url = $url + #url64bit = $url64 + file = $fileLocation + + softwareName = 'choria*' #part or all of the Display Name as you see it in Programs and Features. It should be enough to be unique + + # Checksums are now required as of 0.10.0. + # To determine checksums, you can get that from the original site if provided. + # You can also use checksum.exe (choco install checksum) and use it + # e.g. checksum -t sha256 -f path\to\file + checksum = '' + checksumType = 'sha256' #default is md5, can also be sha1, sha256 or sha512 + checksum64 = 'F0E95A9E578B4009939B23E271678D32A53D0914D529F93D0B4AFB9726D16524' + checksumType64= 'sha256' #default is checksumType + + # MSI + silentArgs = "/qn /norestart /l*v `"$($env:TEMP)\$($packageName).$($env:chocolateyPackageVersion).MsiInstall.log`"" # ALLUSERS=1 DISABLEDESKTOPSHORTCUT=1 ADDDESKTOPICON=0 ADDSTARTMENU=0 + validExitCodes= @(0, 3010, 1641) + # OTHERS + # Uncomment matching EXE type (sorted by most to least common) + #silentArgs = '/S' # NSIS + #silentArgs = '/VERYSILENT /SUPPRESSMSGBOXES /NORESTART /SP-' # Inno Setup + #silentArgs = '/s' # InstallShield + #silentArgs = '/s /v"/qn"' # InstallShield with MSI + #silentArgs = '/s' # Wise InstallMaster + #silentArgs = '-s' # Squirrel + #silentArgs = '-q' # Install4j + #silentArgs = '-s' # Ghost + # Note that some installers, in addition to the silentArgs above, may also need assistance of AHK to achieve silence. + #silentArgs = '' # none; make silent with input macro script like AutoHotKey (AHK) + # https://community.chocolatey.org/packages/autohotkey.portable + #validExitCodes= @(0) #please insert other valid exit codes here +} + +#Install-ChocolateyPackage @packageArgs # https://docs.chocolatey.org/en-us/create/functions/install-chocolateypackage +#Install-ChocolateyZipPackage @packageArgs # https://docs.chocolatey.org/en-us/create/functions/install-chocolateyzippackage +## If you are making your own internal packages (organizations), you can embed the installer or +## put on internal file share and use the following instead (you'll need to add $file to the above) +Install-ChocolateyInstallPackage @packageArgs # https://docs.chocolatey.org/en-us/create/functions/install-chocolateyinstallpackage + +## Main helper functions - these have error handling tucked into them already +## see https://docs.chocolatey.org/en-us/create/functions + +## Install an application, will assert administrative rights +## - https://docs.chocolatey.org/en-us/create/functions/install-chocolateypackage +## - https://docs.chocolatey.org/en-us/create/functions/install-chocolateyinstallpackage +## add additional optional arguments as necessary +##Install-ChocolateyPackage $packageName $fileType $silentArgs $url [$url64 -validExitCodes $validExitCodes -checksum $checksum -checksumType $checksumType -checksum64 $checksum64 -checksumType64 $checksumType64] + +## Download and unpack a zip file - https://docs.chocolatey.org/en-us/create/functions/install-chocolateyzippackage +##Install-ChocolateyZipPackage $packageName $url $toolsDir [$url64 -checksum $checksum -checksumType $checksumType -checksum64 $checksum64 -checksumType64 $checksumType64] + +## Install Visual Studio Package - https://docs.chocolatey.org/en-us/create/functions/install-chocolateyvsixpackage +#Install-ChocolateyVsixPackage $packageName $url [$vsVersion] [-checksum $checksum -checksumType $checksumType] +#Install-ChocolateyVsixPackage @packageArgs + +## see the full list at https://docs.chocolatey.org/en-us/create/functions + +## downloader that the main helpers use to download items +## if removing $url64, please remove from here +## - https://docs.chocolatey.org/en-us/create/functions/get-chocolateywebfile +#Get-ChocolateyWebFile $packageName 'DOWNLOAD_TO_FILE_FULL_PATH' $url $url64 + + +## -------------------------------------------------------------------------------------------------------------------------------------------- +## Installer, will assert administrative rights - used by Install-ChocolateyPackage +## use this for embedding installers in the package when not going to community feed or when you have distribution rights +## - https://docs.chocolatey.org/en-us/create/functions/install-chocolateyinstallpackage +#Install-ChocolateyInstallPackage $packageName $fileType $silentArgs '_FULLFILEPATH_' -validExitCodes $validExitCodes + +## Unzips a file to the specified location - auto overwrites existing content +## - https://docs.chocolatey.org/en-us/create/functions/get-chocolateyunzipp +#Get-ChocolateyUnzip "FULL_LOCATION_TO_ZIP.zip" $toolsDir + +## Runs processes asserting UAC, will assert administrative rights - used by Install-ChocolateyInstallPackage +## - https://docs.chocolatey.org/en-us/create/functions/start-chocolateyprocessasadmin +#Start-ChocolateyProcessAsAdmin 'STATEMENTS_TO_RUN' 'Optional_Application_If_Not_PowerShell' -validExitCodes $validExitCodes + +## To avoid quoting issues, you can also assemble your -Statements in another variable and pass it in +#$appPath = "$env:ProgramFiles\appname" +##Will resolve to C:\Program Files\appname +#$statementsToRun = "/C `"$appPath\bin\installservice.bat`"" +#Start-ChocolateyProcessAsAdmin $statementsToRun cmd -validExitCodes $validExitCodes + +## add specific folders to the path - any executables found in the chocolatey package +## folder will already be on the path. This is used in addition to that or for cases +## when a native installer doesn't add things to the path. +## - https://docs.chocolatey.org/en-us/create/functions/install-chocolateypath +#Install-ChocolateyPath 'LOCATION_TO_ADD_TO_PATH' 'User_OR_Machine' # Machine will assert administrative rights + +## Add specific files as shortcuts to the desktop +## - https://docs.chocolatey.org/en-us/create/functions/install-chocolateyshortcut +#$target = Join-Path $toolsDir "$($packageName).exe" +# Install-ChocolateyShortcut -shortcutFilePath "" -targetPath "" [-workDirectory "C:\" -arguments "C:\test.txt" -iconLocation "C:\test.ico" -description "This is the description"] + +## Outputs the bitness of the OS (either "32" or "64") +## - https://docs.chocolatey.org/en-us/create/functions/get-osarchitecturewidth +#$osBitness = Get-ProcessorBits + +## Set persistent Environment variables +## - https://docs.chocolatey.org/en-us/create/functions/install-chocolateyenvironmentvariable +#Install-ChocolateyEnvironmentVariable -variableName "SOMEVAR" -variableValue "value" [-variableType = 'Machine' #Defaults to 'User'] + +## Set up a file association +## - https://docs.chocolatey.org/en-us/create/functions/install-chocolateyfileassociation +#Install-ChocolateyFileAssociation + +## Adding a shim when not automatically found - Cocolatey automatically shims exe files found in package directory. +## - https://docs.chocolatey.org/en-us/create/functions/install-binfile +## - https://docs.chocolatey.org/en-us/create/create-packages#how-do-i-exclude-executables-from-getting-shims +#Install-BinFile + +##PORTABLE EXAMPLE +#$toolsDir = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)" +# despite the name "Install-ChocolateyZipPackage" this also works with 7z archives +#Install-ChocolateyZipPackage $packageName $url $toolsDir $url64 +## END PORTABLE EXAMPLE + +## [DEPRECATING] PORTABLE EXAMPLE +#$binRoot = Get-BinRoot +#$installDir = Join-Path $binRoot "$packageName" +#Write-Host "Adding `'$installDir`' to the path and the current shell path" +#Install-ChocolateyPath "$installDir" +#$env:Path = "$($env:Path);$installDir" + +# if removing $url64, please remove from here +# despite the name "Install-ChocolateyZipPackage" this also works with 7z archives +#Install-ChocolateyZipPackage "$packageName" "$url" "$installDir" "$url64" +## END PORTABLE EXAMPLE diff --git a/chocolatey/tools/chocolateyuninstall.ps1 b/chocolatey/tools/chocolateyuninstall.ps1 new file mode 100644 index 000000000..9ce8bba3e --- /dev/null +++ b/chocolatey/tools/chocolateyuninstall.ps1 @@ -0,0 +1,83 @@ +# IMPORTANT: Before releasing this package, copy/paste the next 2 lines into PowerShell to remove all comments from this file: +# $f='c:\path\to\thisFile.ps1' +# gc $f | ? {$_ -notmatch "^\s*#"} | % {$_ -replace '(^.*?)\s*?[^``]#.*','$1'} | Out-File $f+".~" -en utf8; mv -fo $f+".~" $f + +## NOTE: In 80-90% of the cases (95% with licensed versions due to Package Synchronizer and other enhancements), +## AutoUninstaller should be able to detect and handle registry uninstalls without a chocolateyUninstall.ps1. +## See https://docs.chocolatey.org/en-us/choco/commands/uninstall +## and https://docs.chocolatey.org/en-us/create/functions/uninstall-chocolateypackage + +## If this is an MSI, ensure 'softwareName' is appropriate, then clean up comments and you are done. +## If this is an exe, change fileType, silentArgs, and validExitCodes + +$ErrorActionPreference = 'Stop'; # stop on all errors +$packageArgs = @{ + packageName = $env:ChocolateyPackageName + softwareName = 'choria*' #part or all of the Display Name as you see it in Programs and Features. It should be enough to be unique + fileType = 'msi' #only one of these: MSI or EXE (ignore MSU for now) + # MSI + silentArgs = "/qn /norestart" + validExitCodes= @(0, 3010, 1605, 1614, 1641) # https://msdn.microsoft.com/en-us/library/aa376931(v=vs.85).aspx + # OTHERS + # Uncomment matching EXE type (sorted by most to least common) + #silentArgs = '/S' # NSIS + #silentArgs = '/VERYSILENT /SUPPRESSMSGBOXES /NORESTART /SP-' # Inno Setup + #silentArgs = '/s' # InstallShield + #silentArgs = '/s /v"/qn"' # InstallShield with MSI + #silentArgs = '/s' # Wise InstallMaster + #silentArgs = '-s' # Squirrel + #silentArgs = '-q' # Install4j + #silentArgs = '-s -u' # Ghost + # Note that some installers, in addition to the silentArgs above, may also need assistance of AHK to achieve silence. + #silentArgs = '' # none; make silent with input macro script like AutoHotKey (AHK) + # https://community.chocolatey.org/packages/autohotkey.portable + #validExitCodes= @(0) #please insert other valid exit codes here +} + +# Get-UninstallRegistryKey is new to 0.9.10, if supporting 0.9.9.x and below, +# take a dependency on "chocolatey-core.extension" in your nuspec file. +# This is only a fuzzy search if $softwareName includes '*'. Otherwise it is +# exact. In the case of versions in key names, we recommend removing the version +# and using '*'. +[array]$key = Get-UninstallRegistryKey -SoftwareName $packageArgs['softwareName'] + +if ($key.Count -eq 1) { + $key | % { + $packageArgs['file'] = "$($_.UninstallString)" #NOTE: You may need to split this if it contains spaces, see below + + if ($packageArgs['fileType'] -eq 'MSI') { + # The Product Code GUID is all that should be passed for MSI, and very + # FIRST, because it comes directly after /x, which is already set in the + # Uninstall-ChocolateyPackage msiargs (facepalm). + $packageArgs['silentArgs'] = "$($_.PSChildName) $($packageArgs['silentArgs'])" + + # Don't pass anything for file, it is ignored for msi (facepalm number 2) + # Alternatively if you need to pass a path to an msi, determine that and + # use it instead of the above in silentArgs, still very first + $packageArgs['file'] = '' + } else { + # NOTES: + # - You probably will need to sanitize $packageArgs['file'] as it comes from the registry and could be in a variety of fun but unusable formats + # - Split args from exe in $packageArgs['file'] and pass those args through $packageArgs['silentArgs'] or ignore them + # - Ensure you don't pass double quotes in $file (aka $packageArgs['file']) - otherwise you will get "Illegal characters in path when you attempt to run this" + # - Review the code for auto-uninstaller for all of the fun things it does in sanitizing - https://github.com/chocolatey/choco/blob/bfe351b7d10c798014efe4bfbb100b171db25099/src/chocolatey/infrastructure.app/services/AutomaticUninstallerService.cs#L142-L192 + } + + Uninstall-ChocolateyPackage @packageArgs + } +} elseif ($key.Count -eq 0) { + Write-Warning "$packageName has already been uninstalled by other means." +} elseif ($key.Count -gt 1) { + Write-Warning "$($key.Count) matches found!" + Write-Warning "To prevent accidental data loss, no programs will be uninstalled." + Write-Warning "Please alert package maintainer the following keys were matched:" + $key | % {Write-Warning "- $($_.DisplayName)"} +} + +## OTHER POWERSHELL FUNCTIONS +## https://docs.chocolatey.org/en-us/create/functions +#Uninstall-ChocolateyZipPackage $packageName # Only necessary if you did not unpack to package directory - see https://docs.chocolatey.org/en-us/create/functions/uninstall-chocolateyzippackage +#Uninstall-ChocolateyEnvironmentVariable # 0.9.10+ - https://docs.chocolatey.org/en-us/create/functions/uninstall-chocolateyenvironmentvariable +#Uninstall-BinFile # Only needed if you used Install-BinFile - see https://docs.chocolatey.org/en-us/create/functions/uninstall-binfile +## Remove any shortcuts you added in the install script. +