Compare commits

...

21 Commits
4.0.0 ... 5.0.0

Author SHA1 Message Date
Brooke Kuhlmann
c01bdeb393 Added version release changes. 2018-08-01 19:51:36 -06:00
Brooke Kuhlmann
f6610849eb Updated Git checkout to silence detached head warnings.
Avoids displaying the following warning in the logs when checking out a
specific version of a project for install purposes:

    You are in 'detached HEAD' state. You can look around, make
    experimental changes and commit them, and you can discard any
    commits you make in this state without impacting any branches by
    performing another checkout.

    If you want to create a new branch to retain commits you create,
    you may do so (now or later) by using -b with the checkout command
    again. Example:

      git checkout -b <new-branch-name>

    HEAD is now at f836f876a178 Added version release changes.
2018-08-01 19:31:23 -06:00
Brooke Kuhlmann
d0c2335f35 Removed restorer functions.
No longer needed as these have been eclipsed by the restore from backup
functionality that uses rsync.
2018-08-01 19:31:23 -06:00
Brooke Kuhlmann
cc9fc3a2f9 Removed Java install support.
No longer used as the installer is prompted for instead.
2018-07-29 17:41:30 -06:00
Brooke Kuhlmann
023c8bbae2 Refactored function parameter documentation.
Cleaned up function documentation to be consistent with rest of
project.
2018-07-29 16:05:09 -06:00
Brooke Kuhlmann
5c12a47f11 Added App Store application verification.
Ensures all listed App Store applications are installed. Otherwise, it
lists those which are not.
2018-07-29 15:48:01 -06:00
Brooke Kuhlmann
cc1b7527fe Added Homebrew cask application verifier.
Verifies installation of Homebrew casks by ensuring installed
applications cross check against defined list.
2018-07-29 15:02:59 -06:00
Brooke Kuhlmann
2f6b385f2f Refactored library function order.
Moved primary functions above secondary functions for easier
readability.
2018-07-29 13:56:00 -06:00
Brooke Kuhlmann
6c06f7107b Fixed verification of Homebrew formulas.
The `verify_homebrew_formulas` function will no longer error when
checking Homebrew formulas due to invalid function name.
2018-07-29 13:37:36 -06:00
Brooke Kuhlmann
da81619140 Updated boot disk format documentation.
Added emphasis for using *Mac OS Extended (Journaled)* format for the
USB drive and *APFS (Encrypted)* for the main drive.
2018-07-28 18:15:39 -06:00
Brooke Kuhlmann
6c4fc52511 Updated README documentation.
Minor edits and clarifications.
2018-07-28 18:15:39 -06:00
Brooke Kuhlmann
ccb9aa8c1d Fixed Markdown ordered list numbering.
Ensures ordered lists start at one instead of zero.

[ci skip]
2018-07-20 10:30:20 -06:00
Brooke Kuhlmann
940ad7e622 Updated Semantic Versioning links to be HTTPS.
It's best to be secure by default.

[ci skip]
2018-06-30 17:10:03 -06:00
Brooke Kuhlmann
f7fb380233 Updated project changes to use semantic versions.
Keeps project changes/history labeled with consistent version labels.

[ci skip]
2018-04-01 12:43:14 -06:00
Brooke Kuhlmann
c0b9be502b Added version release changes. 2018-04-01 10:56:35 -06:00
Brooke Kuhlmann
66cd8d988e Updated to Git Cop 2.2.0.
[Changes](https://is.gd/OEDYpE).
2018-04-01 09:07:07 -06:00
Brooke Kuhlmann
955af0fc9e Updated to Ruby 2.5.1.
[Details](https://is.gd/hSEMaL).
2018-03-30 17:32:36 -06:00
Brooke Kuhlmann
9730e0ce45 Updated to Circle CI 2.0.0 configuration.
Uses latest configuration version in order to not be caught off-guard
if/when they drop v1.0.0 support.

[Details](https://circleci.com/docs/2.0).
2018-01-28 07:44:33 -07:00
Brooke Kuhlmann
94373dd5e8 Updated README screencast tutorial.
Updated to use latest version of software (not that the features have
changed much).
2018-01-07 14:14:22 -07:00
Brooke Kuhlmann
87282969de Updated README license information.
Simplified the text by removing the "(c)" as the use of "Copyright" is
good enough.

[ci skip]
2018-01-06 15:00:50 -07:00
Brooke Kuhlmann
6a6286755e Removed Patreon badge from README.
No longer planning to use this service.

[ci skip]
2018-01-02 20:25:45 -07:00
13 changed files with 338 additions and 336 deletions

View File

@@ -1 +1 @@
2.5.0
2.5.1

View File

@@ -1,11 +1,36 @@
# v4.0.0 (2018-01-01)
# 5.0.0 (2018-08-01)
- Fixed Markdown ordered list numbering.
- Fixed verification of Homebrew formulas.
- Added App Store application verification.
- Added Homebrew cask application verifier.
- Updated Git checkout to silence detached head warnings.
- Updated README documentation.
- Updated Semantic Versioning links to be HTTPS.
- Updated boot disk format documentation.
- Updated project changes to use semantic versions.
- Removed Java install support.
- Removed restorer functions.
- Refactored function parameter documentation.
- Refactored library function order.
# 4.1.0 (2018-04-01)
- Updated README license information.
- Updated README screencast tutorial.
- Updated to Circle CI 2.0.0 configuration.
- Updated to Git Cop 2.2.0.
- Updated to Ruby 2.5.1.
- Removed Patreon badge from README.
# 4.0.0 (2018-01-01)
- Added Gemfile.lock to .gitignore.
- Updated to Apache 2.0 license.
- Updated to Ruby 2.4.3.
- Updated to Ruby 2.5.0.
# v3.1.0 (2017-11-26)
# 3.1.0 (2017-11-26)
- Updated Gemfile.lock file.
- Updated boot disk documenation to mention APFS.
@@ -14,7 +39,7 @@
- Updated to Rake 12.3.0.
- Updated to Rubocop 0.51.0.
# v3.0.0 (2017-10-01)
# 3.0.0 (2017-10-01)
- Fixed table of contents.
- Updated boot disk creation to use macOS High Sierra.
@@ -22,7 +47,7 @@
- Updated to Git Cop 1.6.0.
- Updated to Ruby 2.4.2.
# v2.2.0 (2017-07-16)
# 2.2.0 (2017-07-16)
- Added Git Cop support.
- Updated CONTRIBUTING documentation.
@@ -30,33 +55,33 @@
- Updated README headers.
- Updated gem dependencies.
# v2.1.0 (2017-04-29)
# 2.1.0 (2017-04-29)
- Fixed Java SE Development Kit install.
- Fixed install-all command
# v2.0.0 (2017-04-09)
# 2.0.0 (2017-04-09)
- Added Homebrew Casks install script.
- Updated README semantic versioning order.
- Updated contributing documentation.
- Refactored Homebrew software as Homebrew Formulas.
# v1.3.1 (2017-01-08)
# 1.3.1 (2017-01-08)
- Fixed install of zip app downloads with sub-directories.
# v1.3.0 (2017-01-01)
# 1.3.0 (2017-01-01)
- Updated README versioning documentation.
- Removed CHANGELOG.md (use CHANGES.md instead).
# v1.2.0 (2016-10-12)
# 1.2.0 (2016-10-12)
- Fixed reinstaller path issues with application and extension scripts.
- Added screencast to README.
# v1.1.0 (2016-10-11)
# 1.1.0 (2016-10-11)
- Fixed Bash script header to dynamically load correct environment.
- Fixed verification of Homebrew application installs.
@@ -64,6 +89,6 @@
- Added script hooks for unfinished custom configurations.
- Updated and clarified README documentation.
# v1.0.0 (2016-10-05)
# 1.0.0 (2016-10-05)
- Initial version.

View File

@@ -5,15 +5,15 @@ appreciated. The following sections detail what you need to know in order to con
## Code
0. Read the project README before starting.
0. Fork the `master` branch of this repository and clone the fork locally.
0. Ensure there are no setup, usage, and/or test issues.
0. Add tests for new functionality and ensure they pass.
0. Submit a pull request, follow the instructions it provides, and ensure the build passes.
1. Read the project README before starting.
1. Fork the `master` branch of this repository and clone the fork locally.
1. Ensure there are no setup, usage, and/or test issues.
1. Add tests for new functionality and ensure they pass.
1. Submit a pull request, follow the instructions it provides, and ensure the build passes.
## Issues
0. Submit an issue via the GitHub Issues tab (assuming one does not
- Submit an issue via the GitHub Issues tab (assuming one does not
already exist) and follow the instructions it provides.
## Feedback

View File

@@ -3,4 +3,4 @@
source "https://rubygems.org"
gem "rake", "~> 12.0"
gem "git-cop", "~> 2.0"
gem "git-cop", "~> 2.2"

View File

@@ -1,7 +1,6 @@
# macOS
[![Circle CI Status](https://circleci.com/gh/bkuhlmann/mac_os.svg?style=svg)](https://circleci.com/gh/bkuhlmann/mac_os)
[![Patreon](https://img.shields.io/badge/patreon-donate-brightgreen.svg)](https://www.patreon.com/bkuhlmann)
Shell scripts for automated macOS machine setup.
@@ -12,7 +11,7 @@ project is an opinionated configuration which meets the needs of my development
also meant to serve as an example and guide for building your own personalized setup. Here is how
the two projects are meant to be used:
- **macOS** (this project) - Foundation and framework for building customizated macOS machine
- **macOS** (this project) - The foundation framework for building customizated macOS machine
setups.
- **[macOS Configuration](https://github.com/bkuhlmann/mac_os-config)** - The layer on top of this
*macOS* project which defines a custom machine setup and base implementation. The project is meant
@@ -39,10 +38,9 @@ the two projects are meant to be used:
## Features
- Provides a command line interface, written in Bash with no additional dependencies, for
- Provides a command line interface, written in Bash, with no additional dependencies for
installation and management of a macOS machine.
- Supports macOS boot disk creation for setting up a machine with a fresh install of the operation
system.
- Supports macOS boot disk creation for fresh install of operating system.
- Downloads and installs development tools (required by Homebrew):
- [Xcode Command Line Tools](https://developer.apple.com/xcode)
- [Java SE Development Kit](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)
@@ -58,12 +56,12 @@ the two projects are meant to be used:
## Screencast
[![asciicast](https://asciinema.org/a/88971.png)](https://asciinema.org/a/88971)
[![asciicast](https://asciinema.org/a/155990.png)](https://asciinema.org/a/155990)
## Requirements
0. [macOS High Sierra](https://www.apple.com/macos) (with latest software updates applied)
0. [Xcode](https://developer.apple.com/xcode) (with accepted license agreement)
1. [macOS High Sierra](https://www.apple.com/macos) (with latest software updates applied)
1. [Xcode](https://developer.apple.com/xcode) (with accepted license agreement)
## Setup
@@ -74,7 +72,7 @@ Current Version (stable):
git clone https://github.com/bkuhlmann/mac_os.git
cd mac_os
git checkout v4.0.0
git checkout 5.0.0
Master Version (unstable):
@@ -83,11 +81,11 @@ Master Version (unstable):
## Usage
Run the following script:
Run the following:
bin/run
You will be presented with the following options:
You will be presented with the following options (listed in order of use):
Boot:
B: Create boot disk.
@@ -114,12 +112,12 @@ You will be presented with the following options:
w: Clean work (temp) directory.
q: Quit/Exit.
Choose option `i` to run all install options or select a specific option to run a single option.
Each option is designed to be re-run if necessary. This can also be handy for performing upgrades,
Choose option `i` to run a full install or select a specific option to run a single action. Each
option is designed to be re-run if necessary. This can also be handy for performing upgrades,
re-running a missing/failed install, etc.
The option prompt can be skipped by passing the desired option directly to the `bin/run` script. For
example, executing `bin/run i` will execute the complete software install process.
example, executing `bin/run i` will execute the full install process.
The machine should be rebooted after all install tasks have completed to ensure all settings have
been loaded.
@@ -131,25 +129,21 @@ in order to manage installed software and benefit from future upgrades.
All executable scripts can be found in the `bin` folder:
- `bin/apply_basic_settings`: Applies basic, initial, settings for setting up a machine. *This is
meant to be customized.*
- `bin/apply_default_settings`: Applies useful system and application defaults. *This is meant to be
- `bin/apply_basic_settings`: Applies basic, initial, settings for setting up a machine. *Can be
customized.*
- `bin/apply_default_settings`: Applies useful system and application defaults. *Can be customized.*
- `bin/create_boot_disk`: Creates macOS boot disk.
- `bin/install_app_store`: Installs macOS, GUI-based, App Store applications. *This is meant to be
- `bin/install_app_store`: Installs macOS, GUI-based, App Store applications. *Can be customized.*
- `bin/install_applications`: Installs macOS, GUI-based, non-App Store applications. *Can be
customized.*
- `bin/install_applications`: Installs macOS, GUI-based, non-App Store applications. *This is meant
to be customized.*
- `bin/install_dev_tools`: Installs macOS development tools required by Homebrew.
- `bin/install_extensions`: Installs macOS application extensions and add-ons. *This is meant to be
customized.*
- `bin/install_homebrew_casks`: Installs Homebrew Formulas. *This is meant to be customized.*
- `bin/install_homebrew_formulas`: Installs Homebrew Casks. *This is meant to be customized.*
- `bin/restore_backup`: Restores system/application settings from backup image. *This is meant to be
customized.*
- `bin/install_extensions`: Installs macOS application extensions and add-ons. *Can be customized.*
- `bin/install_homebrew_casks`: Installs Homebrew Formulas. *Can be customized.*
- `bin/install_homebrew_formulas`: Installs Homebrew Casks. *Can be customized.*
- `bin/restore_backup`: Restores system/application settings from backup image. *Can be customized.*
- `bin/run`: The main script and interface for macOS setup.
- `bin/setup_software`: Configures and launches (if necessary) installed software. *This is meant to
be customized.*
- `bin/setup_software`: Configures and launches (if necessary) installed software. *Can be
customized.*
The `lib` folder provides the base framework for installing, re-installing, and uninstalling
software. Everything provided via the [macOS Config](https://github.com/bkuhlmann/mac_os-config)
@@ -160,7 +154,7 @@ project is built upon the functions found in the `lib` folder. See the
## Versioning
Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
Read [Semantic Versioning](https://semver.org) for details. Briefly, it means:
- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
- Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
@@ -177,7 +171,7 @@ Read [CONTRIBUTING](CONTRIBUTING.md) for details.
## License
Copyright (c) 2016 [Alchemists](https://www.alchemists.io).
Copyright 2016 [Alchemists](https://www.alchemists.io).
Read [LICENSE](LICENSE.md) for details.
## History

View File

@@ -5,14 +5,15 @@
# EXECUTION
printf "macOS Boot Disk Tips\n"
printf " - Use a USB drive (8GB or higher is best).\n"
printf " - Use Disk Utility to format the USB drive (Use \"Untitled\" for the label).\n"
printf " - Use a USB drive (8GB or higher).\n"
printf " - Use Disk Utility to format the USB drive as \"Mac OS Extended (Journaled)\".\n"
printf " - Use Disk Utility to label the USB drive as \"Untitled\".\n"
printf "\nmacOS Boot Disk Usage:\n"
printf " 1. Insert the USB boot disk into the machine to be upgraded.\n"
printf " 2. Reboot the machine.\n"
printf " 3. Hold down the OPTION key before the Apple logo appears.\n"
printf " 4. Select the USB boot disk from the menu.\n"
printf " 5. Format the machine's internal drive using Disk Utility (choose APFS).\n"
printf " 5. Use Disk Utility to format the machine's drive as \"APFS (Encrypted)\".\n"
printf " 6. Install the new operating system.\n"
printf "\nmacOS Reinstall:\n"
printf " 1. Click the Apple icon from the operating system main menu.\n"

View File

@@ -10,7 +10,6 @@
source lib/installers.sh
source lib/options.sh
source lib/reinstallers.sh
source lib/restorers.sh
source lib/settings.sh
source lib/uninstallers.sh
source lib/utilities.sh

View File

@@ -1,7 +1,33 @@
dependencies:
pre:
- gem update --system
- gem update bundler
test:
override:
- bundle exec rake
version: 2
jobs:
build:
working_directory: ~/project
docker:
- image: circleci/ruby:2.5
environment:
BUNDLE_JOBS: 3
BUNDLE_RETRY: 3
BUNDLE_PATH: vendor/bundle
EDITOR: vim
steps:
- checkout
- type: cache-restore
name: Bundler Cache Restore
key: bundle-{{ checksum "Gemfile" }}
- run:
name: Bundler Install
command: |
gem update --system
bundle check || bundle install
- type: cache-save
name: Bundler Cache Store
key: bundle-{{ checksum "Gemfile" }}
paths:
- vendor/bundle
- run:
name: Rake Run
command: bundle exec rake

View File

@@ -3,137 +3,8 @@
# DESCRIPTION
# Defines software installer functions.
# Mounts a disk image.
# Parameters:
# $1 = The image path.
mount_image() {
printf "Mounting image...\n"
hdiutil attach -quiet -nobrowse -noautoopen "$1"
}
export -f mount_image
# Unmounts a disk image.
# Parameters:
# $1 = The mount path.
unmount_image() {
printf "Unmounting image...\n"
hdiutil detach -force "$1"
}
export -f unmount_image
# Downloads an installer to local disk.
# Parameters:
# $1 = The URL.
# $2 = The file name.
# $3 = The HTTP header.
download_installer() {
local url="$1"
local file_name="$2"
local http_header="$3"
printf "%s\n" "Downloading $1..."
clean_work_path
mkdir $MAC_OS_WORK_PATH
curl --header "$http_header" --location --retry 3 --retry-delay 5 --fail --silent --show-error "$url" >> "$MAC_OS_WORK_PATH/$file_name"
}
export -f download_installer
# Downloads an installer to the $HOME/Downloads folder for manual use.
# Parameters:
# $1 = The URL.
# $2 = The file name.
download_only() {
if [[ -e "$HOME/Downloads/$2" ]]; then
printf "Downloaded: $2.\n"
else
printf "Downloading $1...\n"
download_installer "$1" "$2"
mv "$MAC_OS_WORK_PATH/$2" "$HOME/Downloads"
fi
}
export -f download_only
# Installs a single file.
# Parameters:
# $1 = The URL.
# $2 = The install path.
install_file() {
local file_url="$1"
local file_name=$(get_file_name "$1")
local install_path="$2"
if [[ ! -e "$install_path" ]]; then
printf "Installing: $install_path...\n"
download_installer "$file_url" "$file_name"
mkdir -p $(dirname "$install_path")
mv "$MAC_OS_WORK_PATH/$file_name" "$install_path"
printf "Installed: $file_name.\n"
verify_path "$install_path"
fi
}
export -f install_file
# Installs an application.
# Parameters:
# $1 = The application source path.
# $2 = The application name.
install_app() {
local install_root=$(get_install_root "$2")
local file_extension=$(get_file_extension "$2")
printf "Installing: $install_root/$2...\n"
case $file_extension in
'app')
cp -a "$1/$2" "$install_root";;
'prefPane')
sudo cp -pR "$1/$2" "$install_root";;
'qlgenerator')
sudo cp -pR "$1/$2" "$install_root" && qlmanage -r;;
*)
printf "ERROR: Unknown file extension: $file_extension.\n"
esac
}
export -f install_app
# Installs a package.
# Parameters:
# $1 = The package source path.
# $2 = The application name.
install_pkg() {
local install_root=$(get_install_root "$2")
printf "Installing: $install_root/$2...\n"
local package=$(sudo find "$1" -maxdepth 1 -type f -name "*.pkg" -o -name "*.mpkg")
sudo installer -pkg "$package" -target /
}
export -f install_pkg
# Installs Java.
# Parameters:
# $1 = The URL.
# $2 = The volume name.
install_java() {
local url="$1"
local volume_path="/Volumes/$2"
local app_name="java"
local install_path="/usr/bin/$app_name"
local download_file="download.dmg"
download_installer "$url" "$download_file" "Cookie: oraclelicense=accept-securebackup-cookie"
mount_image "$MAC_OS_WORK_PATH/$download_file"
local package=$(sudo find "$volume_path" -maxdepth 1 -type f -name "*.pkg")
sudo installer -pkg "$package" -target /
unmount_image "$volume_path"
printf "Installed: $app_name.\n"
}
export -f install_java
# Installs an application via a DMG file.
# Parameters:
# $1 = The URL.
# $2 = The mount path.
# $3 = The application name.
# Parameters: $1 (required) - URL, $2 (required) - Mount path, $3 (required) - Application name.
install_dmg_app() {
local url="$1"
local mount_point="/Volumes/$2"
@@ -152,10 +23,7 @@ install_dmg_app() {
export -f install_dmg_app
# Installs a package via a DMG file.
# Parameters:
# $1 = The URL.
# $2 = The mount path.
# $3 = The application name.
# Parameters: $1 (required) - URL, $2 (required) - Mount path, $3 (required) - Application name.
install_dmg_pkg() {
local url="$1"
local mount_point="/Volumes/$2"
@@ -175,9 +43,7 @@ install_dmg_pkg() {
export -f install_dmg_pkg
# Installs an application via a zip file.
# Parameters:
# $1 = The URL.
# $2 = The application name.
# Parameters: $1 (required) - URL, $2 (required) - Application name.
install_zip_app() {
local url="$1"
local app_name="$2"
@@ -202,10 +68,7 @@ install_zip_app() {
export -f install_zip_app
# Installs an application via a tar file.
# Parameters:
# $1 = The URL.
# $2 = The application name.
# $3 = The decompress options.
# Parameters: $1 (required) - URL, $2 (required) - Application name, $3 (required) - Decompress options.
install_tar_app() {
local url="$1"
local app_name="$2"
@@ -230,9 +93,7 @@ install_tar_app() {
export -f install_tar_app
# Installs a package via a zip file.
# Parameters:
# $1 = The URL.
# $2 = The application name.
# Parameters: $1 (required) - URL, $2 (required) - Application name.
install_zip_pkg() {
local url="$1"
local app_name="$2"
@@ -256,10 +117,7 @@ install_zip_pkg() {
export -f install_zip_pkg
# Installs application code from a Git repository.
# Parameters:
# $1 = Repository URL.
# $2 = Install path.
# $3 = Git clone options (if any).
# Parameters: $1 (required) - Repository URL, $2 (required) - Install path, $3 (optional) - Git clone options.
install_git_app() {
local repository_url="$1"
local app_name=$(get_file_name "$2")
@@ -280,11 +138,7 @@ install_git_app() {
export -f install_git_app
# Installs settings from a Git repository.
# Parameters:
# $1 = The repository URL.
# $2 = The repository version.
# $3 = The project directory.
# $4 = The script to run (including any arguments).
# Parameters: $1 (required) - Repository URL, $2 (required) - Repository version, $3 (required) - Project directory, $4 (required) - Script to run (including any arguments).
install_git_project() {
local repo_url="$1"
local repo_version="$2"
@@ -294,9 +148,102 @@ install_git_project() {
git clone "$repo_url"
(
cd "$project_dir"
git checkout "$repo_version"
git -c advice.detachedHead=false checkout "$repo_version"
eval "$script"
)
rm -rf "$project_dir"
}
export -f install_git_project
# Downloads an installer to local disk.
# Parameters: $1 (required) - URL, $2 (required) - File name, $3 (required) - HTTP header.
download_installer() {
local url="$1"
local file_name="$2"
local http_header="$3"
printf "%s\n" "Downloading $1..."
clean_work_path
mkdir $MAC_OS_WORK_PATH
curl --header "$http_header" --location --retry 3 --retry-delay 5 --fail --silent --show-error "$url" >> "$MAC_OS_WORK_PATH/$file_name"
}
export -f download_installer
# Downloads an installer to the $HOME/Downloads folder for manual use.
# Parameters: $1 (required) - URL, $2 (required) - File name.
download_only() {
if [[ -e "$HOME/Downloads/$2" ]]; then
printf "Downloaded: $2.\n"
else
printf "Downloading $1...\n"
download_installer "$1" "$2"
mv "$MAC_OS_WORK_PATH/$2" "$HOME/Downloads"
fi
}
export -f download_only
# Installs a single file.
# Parameters: $1 (required) - URL, $2 (required) - Install path.
install_file() {
local file_url="$1"
local file_name=$(get_file_name "$1")
local install_path="$2"
if [[ ! -e "$install_path" ]]; then
printf "Installing: $install_path...\n"
download_installer "$file_url" "$file_name"
mkdir -p $(dirname "$install_path")
mv "$MAC_OS_WORK_PATH/$file_name" "$install_path"
printf "Installed: $file_name.\n"
verify_path "$install_path"
fi
}
export -f install_file
# Installs an application.
# Parameters: $1 (required) - Application source path, $2 (required) - Application name.
install_app() {
local install_root=$(get_install_root "$2")
local file_extension=$(get_file_extension "$2")
printf "Installing: $install_root/$2...\n"
case $file_extension in
'app')
cp -a "$1/$2" "$install_root";;
'prefPane')
sudo cp -pR "$1/$2" "$install_root";;
'qlgenerator')
sudo cp -pR "$1/$2" "$install_root" && qlmanage -r;;
*)
printf "ERROR: Unknown file extension: $file_extension.\n"
esac
}
export -f install_app
# Installs a package.
# Parameters: $1 (required) - Package source path, $2 (required) - Application name.
install_pkg() {
local install_root=$(get_install_root "$2")
printf "Installing: $install_root/$2...\n"
local package=$(sudo find "$1" -maxdepth 1 -type f -name "*.pkg" -o -name "*.mpkg")
sudo installer -pkg "$package" -target /
}
export -f install_pkg
# Mounts a disk image.
# Parameters: $1 (required) - Image path.
mount_image() {
printf "Mounting image...\n"
hdiutil attach -quiet -nobrowse -noautoopen "$1"
}
export -f mount_image
# Unmounts a disk image.
# Parameters: $1 (required) - Mount path.
unmount_image() {
printf "Unmounting image...\n"
hdiutil detach -force "$1"
}
export -f unmount_image

View File

@@ -4,8 +4,7 @@
# Defines command line prompt options.
# Process option selection.
# Parameters:
# $1 = The option to process.
# Parameters: $1 (required) - The option to process.
process_option() {
case $1 in
'B')
@@ -43,7 +42,9 @@ process_option() {
'R')
bin/restore_backup;;
'c')
verify_homebrews
verify_homebrew_formulas
verify_homebrew_casks
verify_app_store_applications
verify_applications
verify_extensions;;
'C')

View File

@@ -1,31 +0,0 @@
#! /usr/bin/env bash
# DESCRIPTION
# Defines software restore functions.
# Label: Restore Preference
# Description: Restores an application preference.
# Parameters: $1 (required) - The backup volume root path, $2 (required) - The preference file.
restore_preference() {
local backup_root="$1"
local preference_file="$2"
local backup_path="$backup_root/Users/$USER/Library/Preferences/$preference_file"
local restore_root="$HOME/Library/Preferences"
cp -p "$backup_path" "$restore_root"
}
export -f restore_preference
# Label: Restore Application Support
# Description: Restores application support files.
# Parameters: $1 (required) - The backup volume root path, $2 required - The application name.
restore_app_support() {
local backup_root="$1"
local app_name="$2"
local backup_path="$backup_root/Users/$USER/Library/Application Support/$app_name"
local restore_path="$HOME/Library/Application Support"
mkdir -p "$restore_path"
cp -pR "$backup_path" "$restore_path"
}
export -f restore_app_support

View File

@@ -3,55 +3,8 @@
# DESCRIPTION
# Defines general utility functions.
# Answers the file name.
# Parameters:
# $1 = The file path.
get_file_name() {
printf "${1##*/}" # Answers file or directory name.
}
export -f get_file_name
# Answers the file extension.
# Parameters:
# $1 = The file name.
get_file_extension() {
local name=$(get_file_name "$1")
local extension="${1##*.}" # Excludes dot.
if [[ "$name" == "$extension" ]]; then
printf ''
else
printf "$extension"
fi
}
export -f get_file_extension
# Answers the root install path for file name.
# Parameters:
# $1 = The file name.
get_install_root() {
local file_name="$1"
local file_extension=$(get_file_extension "$file_name")
# Dynamically build the install path based on file extension.
case $file_extension in
'')
printf "/usr/local/bin";;
'app')
printf "/Applications";;
'prefPane')
printf "/Library/PreferencePanes";;
'qlgenerator')
printf "/Library/QuickLook";;
*)
printf "/tmp/unknown";;
esac
}
export -f get_install_root
# Answers the full install path (including file name) for file name.
# Parameters:
# $1 = The file name.
# Parameters: $1 (required) - The file name.
get_install_path() {
local file_name="$1"
local install_path=$(get_install_root "$file_name")
@@ -77,3 +30,46 @@ caffeinate_machine() {
fi
}
export -f caffeinate_machine
# Answers the root install path for file name.
# Parameters: $1 (required) - The file name.
get_install_root() {
local file_name="$1"
local file_extension=$(get_file_extension "$file_name")
# Dynamically build the install path based on file extension.
case $file_extension in
'')
printf "/usr/local/bin";;
'app')
printf "/Applications";;
'prefPane')
printf "/Library/PreferencePanes";;
'qlgenerator')
printf "/Library/QuickLook";;
*)
printf "/tmp/unknown";;
esac
}
export -f get_install_root
# Answers the file extension.
# Parameters: $1 (required) - The file name.
get_file_extension() {
local name=$(get_file_name "$1")
local extension="${1##*.}" # Excludes dot.
if [[ "$name" == "$extension" ]]; then
printf ''
else
printf "$extension"
fi
}
export -f get_file_extension
# Answers the file name.
# Parameters: $1 (required) - The file path.
get_file_name() {
printf "${1##*/}" # Answers file or directory name.
}
export -f get_file_name

View File

@@ -3,22 +3,9 @@
# DESCRIPTION
# Defines verification/validation functions.
# Verifies Homebrew software exists.
# Parameters:
# $1 = The file name.
verify_homebrew() {
local application="$1"
local applications="$2"
if [[ "${applications[*]}" != *"$application"* ]]; then
printf " - Missing: $application\n"
fi
}
export -f verify_homebrew
# Checks for missing Homebrew software.
verify_homebrews() {
printf "Checking Homebrew software...\n"
# Checks for missing Homebrew formulas.
verify_homebrew_formulas() {
printf "Checking Homebrew formulas...\n"
local applications="$(brew list)"
@@ -37,28 +24,72 @@ verify_homebrews() {
application="mercurial"
fi
verify_homebrew "$application" "${applications[*]}"
verify_listed_application "$application" "${applications[*]}"
fi
done < "$MAC_OS_CONFIG_PATH/bin/install_homebrew"
done < "$MAC_OS_CONFIG_PATH/bin/install_homebrew_formulas"
printf "Homebrew check complete.\n"
printf "Homebrew formula check complete.\n"
}
export -f verify_homebrews
export -f verify_homebrew_formulas
# Verifies application exists.
# Parameters:
# $1 = The file name.
verify_application() {
local file_name="$1"
# Checks for missing Homebrew casks.
verify_homebrew_casks() {
printf "\nChecking Homebrew casks...\n"
# Display the missing install if not found.
local install_path=$(get_install_path "$file_name")
local applications="$(brew cask list)"
if [[ ! -e "$install_path" ]]; then
printf " - Missing: $file_name\n"
while read line; do
# Skip blank or comment lines.
if [[ "$line" == "brew cask install"* ]]; then
local application=$(printf "$line" | awk '{print $4}')
# Skip: Only necessary for the purpose of licensing system preference.
if [[ "$application" == "witch" ]]; then
continue
fi
# Skip: Bug with Homebrew Cask as these apps never show up as installed.
if [[ "$application" == "skitch" || "$application" == "openemu" ]]; then
continue
fi
verify_listed_application "$application" "${applications[*]}"
fi
done < "$MAC_OS_CONFIG_PATH/bin/install_homebrew_casks"
printf "Homebrew cask check complete.\n"
}
export -f verify_homebrew_casks
# Checks for missing App Store applications.
verify_app_store_applications() {
printf "\nChecking App Store applications...\n"
local applications="$(mas list)"
while read line; do
# Skip blank or comment lines.
if [[ "$line" == "mas install"* ]]; then
local application=$(printf "$line" | awk '{print $3}')
verify_listed_application "$application" "${applications[*]}"
fi
done < "$MAC_OS_CONFIG_PATH/bin/install_app_store"
printf "App Store check complete.\n"
}
export -f verify_app_store_applications
# Verifies listed application exists.
# Parameters: $1 (required) - The current application, $2 (required) - The application list.
verify_listed_application() {
local application="$1"
local applications="$2"
if [[ "${applications[*]}" != *"$application"* ]]; then
printf " - Missing: $application\n"
fi
}
export -f verify_application
export -f verify_listed_application
# Checks for missing applications suffixed by "APP_NAME" as defined in settings.sh.
verify_applications() {
@@ -77,18 +108,19 @@ verify_applications() {
}
export -f verify_applications
# Verifies path exists.
# Parameters:
# $1 = The path.
verify_path() {
local path="$1"
# Verifies application exists.
# Parameters: $1 (required) - The file name.
verify_application() {
local file_name="$1"
# Display the missing path if not found.
if [[ ! -e "$path" ]]; then
printf " - Missing: $path\n"
# Display the missing install if not found.
local install_path=$(get_install_path "$file_name")
if [[ ! -e "$install_path" ]]; then
printf " - Missing: $file_name\n"
fi
}
export -f verify_path
export -f verify_application
# Checks for missing extensions suffixed by "EXTENSION_PATH" as defined in settings.sh.
verify_extensions() {
@@ -106,3 +138,15 @@ verify_extensions() {
printf "Application extension check complete.\n"
}
export -f verify_extensions
# Verifies path exists.
# Parameters: $1 (required) - The path.
verify_path() {
local path="$1"
# Display the missing path if not found.
if [[ ! -e "$path" ]]; then
printf " - Missing: $path\n"
fi
}
export -f verify_path