From 30c4288a161199ac178d05eecf588299cb2d0ea2 Mon Sep 17 00:00:00 2001 From: Andrew Stowell Date: Thu, 5 May 2022 20:07:21 +0000 Subject: [PATCH] Squashed 'golang-install/' content from commit 258f94f git-subtree-dir: golang-install git-subtree-split: 258f94f6120bbf99f4c9133c9ab5826dcd359fbe --- .github/FUNDING.yml | 2 + .travis.yml | 39 +++++++ LICENSE.md | 177 +++++++++++++++++++++++++++++++ README.md | 78 ++++++++++++++ goinstall.sh | 165 ++++++++++++++++++++++++++++ tests/custom-version-validate.sh | 13 +++ tests/install-custom-version.sh | 6 ++ tests/install.sh | 6 ++ tests/remove.sh | 4 + tests/validate.sh | 23 ++++ 10 files changed, 513 insertions(+) create mode 100644 .github/FUNDING.yml create mode 100644 .travis.yml create mode 100644 LICENSE.md create mode 100644 README.md create mode 100755 goinstall.sh create mode 100644 tests/custom-version-validate.sh create mode 100644 tests/install-custom-version.sh create mode 100755 tests/install.sh create mode 100644 tests/remove.sh create mode 100644 tests/validate.sh diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..e029784 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,2 @@ +liberapay: canha + diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..6a3a159 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,39 @@ +language: bash + +matrix: + include: + - os: linux + dist: focal # 20.04 + - os: linux + dist: bionic # 18.04 (EOL @ April 2023) + - os: osx + osx_image: xcode12.5 # 11.3 + - os: osx + osx_image: xcode12.2 # 10.15.7 + + +install: true +env: REQVER=1.16.7 + +addons: + homebrew: + packages: + - fish + update: true + apt: + packages: + - fish + update: true + +script: >- + bash tests/install.sh && + source ~/.bashrc && + bash tests/validate.sh && + bash tests/remove.sh + + bash tests/install-custom-version.sh && + source ~/.bashrc && + bash tests/custom-version-validate.sh && + bash tests/remove.sh + + SHELL=$(which fish) bash tests/install.sh \ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..51910cf --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,177 @@ +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 + diff --git a/README.md b/README.md new file mode 100644 index 0000000..87e3543 --- /dev/null +++ b/README.md @@ -0,0 +1,78 @@ +# golang-tools-install-script + +Bash script to automate installation and removal of single-user Go language tools. + +Feel free to change the variables on the beginning to match whatever version of Go you need. + +Tested working on: + +* :white_check_mark: Ubuntu 16.04 to 20.04 +* :white_check_mark: macOS Sierra (10.12) to Big Sur (11.3) + +Supported shells: +* Bash, fish, Zsh + +## :hammer: Requirements +* `wget` or `curl` +* Bash shell + +## :fast_forward: Install + +Download and run with `wget` or `curl`. Here's the short version using the official git.io shortening: + +```shell +# Linux typically has wget installed +wget -q -O - https://git.io/vQhTU | bash + +# macOS typically has curl installed +curl -L https://git.io/vQhTU | bash +``` + +Or, if you are more comfortable with the raw URL: +```shell +wget -q -O - https://raw.githubusercontent.com/canha/golang-tools-install-script/master/goinstall.sh | bash + +# or... +curl https://raw.githubusercontent.com/canha/golang-tools-install-script/master/goinstall.sh | bash +``` + +## :package: Install a custom Go version + +Pass the `--version` option into the script including the version that you wish to install. + +##### Example: + +```shell +wget -q -O - https://git.io/vQhTU | bash -s -- --version 1.18 + +# or... +curl -L https://git.io/vQhTU | bash -s -- --version 1.18 +``` + +## :no_entry_sign: Uninstall + +Pass the `--remove` option into the script: + +```shell +wget -q -O - https://git.io/vQhTU | bash -s -- --remove + +# or... +curl -L https://git.io/vQhTU | bash -s -- --remove +``` + +## :pencil: Notes + +By default, the script will create `.go` and `go` folders on your home directory and add the needed variables and `PATH` expansion. + +`$HOME/.go is the directory where Go will be installed to.` + +`$HOME/go is the default workspace directory.` + +Read more about the [workspace](http://golang.org/doc/code.html). + +In order to install Go into another location, set the environment variables `$GOROOT` and `$GOPATH` before (un)installing: + +```shell +export GOROOT=/opt/go +export GOPATH=$HOME/projects/go +``` diff --git a/goinstall.sh b/goinstall.sh new file mode 100755 index 0000000..097a045 --- /dev/null +++ b/goinstall.sh @@ -0,0 +1,165 @@ +#!/bin/bash +# shellcheck disable=SC2016 +set -e + +VERSION="1.18.1" + +[ -z "$GOROOT" ] && GOROOT="$HOME/.go" +[ -z "$GOPATH" ] && GOPATH="$HOME/go" + +OS="$(uname -s)" +ARCH="$(uname -m)" + +case $OS in + "Linux") + case $ARCH in + "x86_64") + ARCH=amd64 + ;; + "aarch64") + ARCH=arm64 + ;; + "armv6" | "armv7l") + ARCH=armv6l + ;; + "armv8") + ARCH=arm64 + ;; + .*386.*) + ARCH=386 + ;; + esac + PLATFORM="linux-$ARCH" + ;; + "Darwin") + case $ARCH in + "x86_64") + ARCH=amd64 + ;; + "arm64") + ARCH=arm64 + ;; + esac + PLATFORM="darwin-$ARCH" + ;; +esac + +print_help() { + echo "Usage: bash goinstall.sh OPTIONS" + echo -e "\nOPTIONS:" + echo -e " --remove\tRemove currently installed version" + echo -e " --version\tSpecify a version number to install" +} + +if [ -z "$PLATFORM" ]; then + echo "Your operating system is not supported by the script." + exit 1 +fi + +if [ -n "$($SHELL -c 'echo $ZSH_VERSION')" ]; then + shell_profile="$HOME/.zshrc" +elif [ -n "$($SHELL -c 'echo $BASH_VERSION')" ]; then + shell_profile="$HOME/.bashrc" +elif [ -n "$($SHELL -c 'echo $FISH_VERSION')" ]; then + shell="fish" + if [ -d "$XDG_CONFIG_HOME" ]; then + shell_profile="$XDG_CONFIG_HOME/fish/config.fish" + else + shell_profile="$HOME/.config/fish/config.fish" + fi +fi + +if [ "$1" == "--remove" ]; then + rm -rf "$GOROOT" + if [ "$OS" == "Darwin" ]; then + if [ "$shell" == "fish" ]; then + sed -i "" '/# GoLang/d' "$shell_profile" + sed -i "" '/set GOROOT/d' "$shell_profile" + sed -i "" '/set GOPATH/d' "$shell_profile" + sed -i "" '/set PATH $GOPATH\/bin $GOROOT\/bin $PATH/d' "$shell_profile" + else + sed -i "" '/# GoLang/d' "$shell_profile" + sed -i "" '/export GOROOT/d' "$shell_profile" + sed -i "" '/$GOROOT\/bin/d' "$shell_profile" + sed -i "" '/export GOPATH/d' "$shell_profile" + sed -i "" '/$GOPATH\/bin/d' "$shell_profile" + fi + else + if [ "$shell" == "fish" ]; then + sed -i '/# GoLang/d' "$shell_profile" + sed -i '/set GOROOT/d' "$shell_profile" + sed -i '/set GOPATH/d' "$shell_profile" + sed -i '/set PATH $GOPATH\/bin $GOROOT\/bin $PATH/d' "$shell_profile" + else + sed -i '/# GoLang/d' "$shell_profile" + sed -i '/export GOROOT/d' "$shell_profile" + sed -i '/$GOROOT\/bin/d' "$shell_profile" + sed -i '/export GOPATH/d' "$shell_profile" + sed -i '/$GOPATH\/bin/d' "$shell_profile" + fi + fi + echo "Go removed." + exit 0 +elif [ "$1" == "--help" ]; then + print_help + exit 0 +elif [ "$1" == "--version" ]; then + if [ -z "$2" ]; then # Check if --version has a second positional parameter + echo "Please provide a version number for: $1" + else + VERSION=$2 + fi +elif [ ! -z "$1" ]; then + echo "Unrecognized option: $1" + exit 1 +fi + +if [ -d "$GOROOT" ]; then + echo "The Go install directory ($GOROOT) already exists. Exiting." + exit 1 +fi + +PACKAGE_NAME="go$VERSION.$PLATFORM.tar.gz" +TEMP_DIRECTORY=$(mktemp -d) + +echo "Downloading $PACKAGE_NAME ..." +if hash wget 2>/dev/null; then + wget https://storage.googleapis.com/golang/$PACKAGE_NAME -O "$TEMP_DIRECTORY/go.tar.gz" +else + curl -o "$TEMP_DIRECTORY/go.tar.gz" https://storage.googleapis.com/golang/$PACKAGE_NAME +fi + +if [ $? -ne 0 ]; then + echo "Download failed! Exiting." + exit 1 +fi + +echo "Extracting File..." +mkdir -p "$GOROOT" + +tar -C "$GOROOT" --strip-components=1 -xzf "$TEMP_DIRECTORY/go.tar.gz" + +echo "Configuring shell profile in: $shell_profile" +touch "$shell_profile" +if [ "$shell" == "fish" ]; then + { + echo '# GoLang' + echo "set GOROOT '${GOROOT}'" + echo "set GOPATH '$GOPATH'" + echo 'set PATH $GOPATH/bin $GOROOT/bin $PATH' + } >> "$shell_profile" +else + { + echo '# GoLang' + echo "export GOROOT=${GOROOT}" + echo 'export PATH=$GOROOT/bin:$PATH' + echo "export GOPATH=$GOPATH" + echo 'export PATH=$GOPATH/bin:$PATH' + } >> "$shell_profile" +fi + +mkdir -p "${GOPATH}/"{src,pkg,bin} +echo -e "\nGo $VERSION was installed into $GOROOT.\nMake sure to relogin into your shell or run:" +echo -e "\n\tsource $shell_profile\n\nto update your environment variables." +echo "Tip: Opening a new terminal window usually just works. :)" +rm -f "$TEMP_DIRECTORY/go.tar.gz" diff --git a/tests/custom-version-validate.sh b/tests/custom-version-validate.sh new file mode 100644 index 0000000..ad56f9b --- /dev/null +++ b/tests/custom-version-validate.sh @@ -0,0 +1,13 @@ +#!/bin/bash +set -e +GOVER=$(go version) + +echo "Testing to make sure that Go $REQVER is installed" + +if grep -q "$REQVER" <<< "$GOVER"; then + echo "Version contains: $REQVER" + exit 0 +else + echo "Does not contain: $REQVER" + exit 1 +fi diff --git a/tests/install-custom-version.sh b/tests/install-custom-version.sh new file mode 100644 index 0000000..9918ec6 --- /dev/null +++ b/tests/install-custom-version.sh @@ -0,0 +1,6 @@ +#!/bin/bash +set -e + +unset GOROOT +unset GOPATH +"$(dirname "$0")/../goinstall.sh" --version "${REQVER}" diff --git a/tests/install.sh b/tests/install.sh new file mode 100755 index 0000000..c1490ae --- /dev/null +++ b/tests/install.sh @@ -0,0 +1,6 @@ +#!/bin/bash +set -e + +unset GOROOT +unset GOPATH +"$(dirname "$0")/../goinstall.sh" diff --git a/tests/remove.sh b/tests/remove.sh new file mode 100644 index 0000000..52ebdf2 --- /dev/null +++ b/tests/remove.sh @@ -0,0 +1,4 @@ +#!/bin/bash +set -e + +"$(dirname "$0")/../goinstall.sh" --remove diff --git a/tests/validate.sh b/tests/validate.sh new file mode 100644 index 0000000..b574719 --- /dev/null +++ b/tests/validate.sh @@ -0,0 +1,23 @@ +#!/bin/bash +set -e + +mkdir -p "/tmp/validate-go" +pushd "/tmp/validate-go" +go mod init example.com/user/hello +cat >hello.go <