Merge branch 'master' into master

This commit is contained in:
Will Owens
2024-02-27 06:05:52 -05:00
committed by GitHub
13 changed files with 228 additions and 187 deletions

40
.github/workflows/test.yml vendored Normal file
View File

@@ -0,0 +1,40 @@
name: Test
on:
push:
branches:
- master
pull_request:
branches:
- master
jobs:
test:
strategy:
matrix:
os:
- ubuntu-latest
- macos-latest
test_shell:
- bash
- zsh
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
- uses: cachix/install-nix-action@v25
with:
github_access_token: ${{ secrets.GITHUB_TOKEN }}
nix_path: nixpkgs=channel:nixos-unstable
- run: |
git config --global init.defaultBranch master
git config --global user.name scm_breeze@scm_breeze
git config --global user.email "SCM Breeze"
- name: test
env:
TEST_SHELLS: ${{ matrix.test_shell }}
run: nix-shell -p ruby $TEST_SHELLS --command ./run_tests.sh
# - run: nix-shell -p shunit2 -i ./run_tests.sh
# - run: nix build
# - run: nix flake check

View File

@@ -1,18 +0,0 @@
os:
- linux
- osx
env:
- TEST_SHELLS=bash
- TEST_SHELLS=zsh
sudo: required
install:
- ./test/support/travisci_deps.sh
before_script:
- echo -e "test_repo_11\ntest_repo_1" | sort
script:
- ./run_tests.sh

View File

@@ -181,7 +181,7 @@ doesn't need to 'learn' anything, and it can do SCM-specific stuff like:
The default alias for `git_index` is 'c', which might stand for 'code'
You will first need to configure your repository directory by setting `GIT_REPO_DIR` in `~/.git.sbmrc`.
You will first need to configure your repository directory by setting `GIT_REPO_DIR` in `~/.git.scmbrc`.
Then, build the index:

View File

@@ -126,6 +126,6 @@ git_add_and_amend_commit_keys="\C-xz" # CTRL+x, z
# Expand numbered args for common shell commands
shell_command_wrapping_enabled="true"
# Here you can tweak the list of wrapped commands.
scmb_wrapped_shell_commands="vim emacs gedit cat rm cp mv ln cd ls less subl code"
scmb_wrapped_shell_commands=(vim emacs gedit cat rm cp mv ln cd ls less subl code)
# Add numbered shortcuts to output of ls -l, just like 'git status'
shell_ls_aliases_enabled="true"

View File

@@ -173,8 +173,8 @@ if [ "$git_setup_aliases" = "yes" ]; then
_alias "$git_log_graph_alias" 'git log --graph --max-count=5'
_alias "$git_add_all_alias" 'git add --all .'
# Hub aliases (https://github.com/github/hub)
_alias "$git_pull_request_alias" 'git pull-request'
# GitHub CLI aliases (https://github.com/cli/cli)
_alias "$git_pull_request_alias" 'gh pr'
fi

View File

@@ -17,7 +17,7 @@ function _scmb_git_branch_shortcuts {
# Fall back to normal git branch, if any unknown args given
if [[ "$($_git_cmd branch | wc -l)" -gt 300 ]] || ([[ -n "$@" ]] && [[ "$@" != "-a" ]]); then
exec_scmb_expand_args $_git_cmd branch "$@"
return 1
return $?
fi
# Use ruby to inject numbers into git branch output

View File

@@ -171,7 +171,7 @@ function is_git_dirty {
[[ $($GIT_BINARY status 2> /dev/null | tail -n1) != "nothing to commit (working directory clean)" ]] && echo "*"
}
function parse_git_branch {
$GIT_BINARY branch --no-color 2> /dev/null | sed -e '/^[^*]/d' -e "s/* \(.*\)/\1/"
git rev-parse --abbrev-ref HEAD 2> /dev/null
}
# If the working directory is clean, update the git repository. Otherwise, show changes.

View File

@@ -4,7 +4,6 @@
# Released under the LGPL (GNU Lesser General Public License)
# ------------------------------------------------------------------------------
if sed -E 's///g' </dev/null &>/dev/null; then
SED_REGEX_ARG="E"
elif sed -r 's///g' </dev/null &>/dev/null; then
@@ -13,7 +12,6 @@ else
echo "Cannot determine extended regex argument for sed! (Doesn't respond to either -E or -r)"
fi
# Wrap common commands with numeric argument expansion.
# Prepends everything with exec_scmb_expand_args,
# even if commands are already aliases or functions
@@ -23,7 +21,7 @@ if [ "$shell_command_wrapping_enabled" = "true" ] || [ "$bash_command_wrapping_e
# Define 'whence' for bash, to get the value of an alias
type whence >/dev/null 2>&1 || function whence() { LC_MESSAGES="C" type "$@" | sed -$SED_REGEX_ARG -e "s/.*is aliased to \`//" -e "s/'$//"; }
local cmd=''
for cmd in $scmb_wrapped_shell_commands; do
for cmd in "${scmb_wrapped_shell_commands[@]}"; do
if [ "${scmbDebug:-}" = "true" ]; then echo "SCMB: Wrapping $cmd..."; fi
# Special check for 'cd', to make sure SCM Breeze is loaded after RVM
@@ -39,10 +37,12 @@ if [ "$shell_command_wrapping_enabled" = "true" ] || [ "$bash_command_wrapping_e
# Don't do anything if command already aliased, or not found.
*'exec_scmb_expand_args'*)
if [ "${scmbDebug:-}" = "true" ]; then echo "SCMB: $cmd is already wrapped"; fi;;
if [ "${scmbDebug:-}" = "true" ]; then echo "SCMB: $cmd is already wrapped"; fi
;;
*'not found'*)
if [ "${scmbDebug:-}" = "true" ]; then echo "SCMB: $cmd not found!"; fi;;
if [ "${scmbDebug:-}" = "true" ]; then echo "SCMB: $cmd not found!"; fi
;;
*'aliased to'* | *'is an alias for'*)
if [ "${scmbDebug:-}" = "true" ]; then echo "SCMB: $cmd is an alias"; fi
@@ -62,7 +62,8 @@ if [ "$shell_command_wrapping_enabled" = "true" ] || [ "$bash_command_wrapping_e
# Expand original command into full path, to avoid infinite loops
local expanded_alias="$(echo $original_alias | sed -$SED_REGEX_ARG "s%(^| )$cmd($| )%\\1$escaped_cmd\\2%")"
# Wrap previous alias with escaped command
alias $cmd="exec_scmb_expand_args $expanded_alias";;
alias $cmd="exec_scmb_expand_args $expanded_alias"
;;
*'is a'*'function'*)
if [ "${scmbDebug:-}" = "true" ]; then echo "SCMB: $cmd is a function"; fi
@@ -71,18 +72,21 @@ if [ "$shell_command_wrapping_enabled" = "true" ] || [ "$bash_command_wrapping_e
# Remove function
unset -f "$cmd"
# Create function that wraps old function
eval "${cmd}(){ exec_scmb_expand_args __original_${cmd} \"\$@\"; }";;
eval "${cmd}(){ exec_scmb_expand_args __original_${cmd} \"\$@\"; }"
;;
*'is a shell builtin'*)
if [ "${scmbDebug:-}" = "true" ]; then echo "SCMB: $cmd is a shell builtin"; fi
# Handle shell builtin commands
alias $cmd="exec_scmb_expand_args builtin $cmd";;
alias $cmd="exec_scmb_expand_args builtin $cmd"
;;
*)
if [ "${scmbDebug:-}" = "true" ]; then echo "SCMB: $cmd is an executable file"; fi
# Otherwise, command is a regular script or binary,
# and the full path can be found with 'find_binary' function
alias $cmd="exec_scmb_expand_args '$(find_binary $cmd)'";;
alias $cmd="exec_scmb_expand_args '$(find_binary $cmd)'"
;;
esac
done
# Clean up
@@ -91,7 +95,6 @@ if [ "$shell_command_wrapping_enabled" = "true" ] || [ "$bash_command_wrapping_e
_git_wrap_commands
fi
# Function wrapper around 'll'
# Adds numbered shortcuts to output of ls -l, just like 'git status'
if [ "$shell_ls_aliases_enabled" = "true" ] && builtin command -v ruby >/dev/null 2>&1; then
@@ -111,7 +114,8 @@ if [ "$shell_ls_aliases_enabled" = "true" ] && builtin command -v ruby > /dev/nu
_abs_path_command=(perl -e 'use Cwd abs_path; print abs_path(shift)')
fi
unalias ll > /dev/null 2>&1; unset -f ll > /dev/null 2>&1
unalias ll >/dev/null 2>&1
unset -f ll >/dev/null 2>&1
function ls_with_file_shortcuts {
local ll_output
local ll_command # Ensure sort ordering of the two invocations is the same
@@ -168,12 +172,12 @@ if [ "$shell_ls_aliases_enabled" = "true" ] && builtin command -v ruby > /dev/nu
local USER_SYM=$(/bin/cat $HOME/.user_sym)
if [ -f "$HOME/.staff_sym" ]; then
local STAFF_SYM=$(/bin/cat $HOME/.staff_sym)
ll_output=$(echo "$ll_output" | \
\sed -$SED_REGEX_ARG "s/ $USER staff/ $USER_SYM $STAFF_SYM /g" | \
ll_output=$(echo "$ll_output" |
\sed -$SED_REGEX_ARG "s/ $USER staff/ $USER_SYM $STAFF_SYM /g" |
rejustify_ls_columns)
else
ll_output=$(echo "$ll_output" | \
\sed -$SED_REGEX_ARG "s/ $USER/ $USER_SYM /g" | \
ll_output=$(echo "$ll_output" |
\sed -$SED_REGEX_ARG "s/ $USER/ $USER_SYM /g" |
rejustify_ls_columns)
fi
fi
@@ -186,7 +190,8 @@ if [ "$shell_ls_aliases_enabled" = "true" ] && builtin command -v ruby > /dev/nu
fi
# Use ruby to inject numbers into ls output
echo "$ll_output" | ruby -e "$( \cat <<EOF
echo "$ll_output" | ruby -e "$(
\cat <<EOF
output = STDIN.read
e = 1
re = /^(([^ ]* +){8})/

View File

@@ -88,7 +88,7 @@ puts "%s#%s On branch: %s#{@branch}#{difference}%s %s| [%s*%s]%s => $#{ENV["gi
]
def has_modules?
@has_modules ||= File.exists?(File.join(@project_root, '.gitmodules'))
@has_modules ||= File.exist?(File.join(@project_root, '.gitmodules'))
end
# Index modification states

View File

@@ -3,6 +3,8 @@
failed=false
env | grep ^SHELL
# allow list of shells to run tests in to be overriden by environment variable
# if empty or null, use defaults
if [ -z "$TEST_SHELLS" ]; then
@@ -15,6 +17,7 @@ for test in $(find test/lib -name *_test.sh); do
for shell in $TEST_SHELLS; do
echo "== Running tests with [$shell]: $test"
$shell $test || failed=true
printf '==\n\n'
done
done

View File

@@ -11,7 +11,9 @@ export scmbDir="$( cd -P "$( dirname "$0" )" && pwd )/../../.."
# Zsh compatibility
if [ -n "${ZSH_VERSION:-}" ]; then
shell="zsh"; SHUNIT_PARENT=$0; setopt shwordsplit
shell="zsh"
SHUNIT_PARENT=$0
setopt shwordsplit
else
# Bash needs this option so that 'alias' works in a non-interactive shell
shopt -s expand_aliases
@@ -25,7 +27,7 @@ source "$scmbDir/lib/scm_breeze.sh"
#-----------------------------------------------------------------------------
oneTimeSetUp() {
export shell_command_wrapping_enabled="true"
export scmb_wrapped_shell_commands="not_found cat rm cp mv ln cd sed"
export scmb_wrapped_shell_commands=("not_found" "cat" "rm" "cp" "mv" "ln" "cd" "sed")
export shell_ls_aliases_enabled="true"
alias rvm="test" # Ensure tests run if RVM isn't loaded but $HOME/.rvm is present
@@ -47,6 +49,13 @@ oneTimeSetUp() {
# Test already wrapped commands
alias cat="exec_scmb_expand_args $cat_path"
root_test_dir=/aaa
if [ "$(uname)" = "Darwin" ]; then
root_test_dir=/Applications
else
sudo mkdir $root_test_dir
fi
# Run shortcut wrapping
source "$scmbDir/lib/git/shell_shortcuts.sh"
@@ -61,7 +70,6 @@ assertAliasEquals(){
assertEquals "$1" "$(whence $2)"
}
#-----------------------------------------------------------------------------
# Setup and tear down
#-----------------------------------------------------------------------------
@@ -70,7 +78,6 @@ setUp() {
unset QUOTING_STYLE # Use default quoting style for ls
}
#-----------------------------------------------------------------------------
# Unit tests
#-----------------------------------------------------------------------------
@@ -143,8 +150,14 @@ test_ls_with_file_shortcuts() {
# Files under the root directory
assertTrue 'Shortcuts under /' 'ls_with_file_shortcuts / >/dev/null && [[ $e1 =~ ^/[^/]+$ ]]'
ls_with_file_shortcuts / >/dev/null
assertTrue "$e1 == $root_test_dir" '[[ "$e1" == "$root_test_dir" ]]'
cd -
rm -r "$TEST_DIR" "$temp_file"
if [ "$(uname)" != "Darwin" ]; then
sudo rmdir "$root_test_dir"
fi
}
# load and run shUnit2

View File

@@ -10,7 +10,12 @@
export scmbDir="$(cd -P "$(dirname "$0")" && pwd)/../../.."
# Zsh compatibility
if [ -n "${ZSH_VERSION:-}" ]; then shell="zsh"; SHUNIT_PARENT=$0; setopt shwordsplit; fi
if [ -n "${ZSH_VERSION:-}" ]; then
shell="zsh"
SHUNIT_PARENT=$0
setopt shwordsplit
setopt append_history
fi
# Load test helpers
source "$scmbDir/test/support/test_helper.sh"
@@ -19,7 +24,6 @@ source "$scmbDir/test/support/test_helper.sh"
source "$scmbDir/lib/scm_breeze.sh"
source "$scmbDir/lib/git/status_shortcuts.sh"
# Setup and tear down
#-----------------------------------------------------------------------------
oneTimeSetUp() {
@@ -43,7 +47,6 @@ setupTestRepo() {
git init >/dev/null
}
#-----------------------------------------------------------------------------
# Unit tests
#-----------------------------------------------------------------------------
@@ -52,19 +55,37 @@ test_scmb_expand_args() {
local e1="one" e2="two" e3="three" e4="four" e5="five" e6="six" e7='$dollar' e8='two words'
local error="Args not expanded correctly"
assertEquals "$error" 'one three six' \
"$(eval args="$(scmb_expand_args 1 3 6)"; token_quote "${args[@]}")"
"$(
eval args="$(scmb_expand_args 1 3 6)"
token_quote "${args[@]}"
)"
assertEquals "$error" 'one two three five' \
"$(eval args="$(scmb_expand_args 1-3 5)"; token_quote "${args[@]}")"
"$(
eval args="$(scmb_expand_args 1-3 5)"
token_quote "${args[@]}"
)"
assertEquals "$error" '\$dollar two three four one' \
"$(eval args="$(scmb_expand_args 7 2-4 1)"; token_quote "${args[@]}")"
"$(
eval args="$(scmb_expand_args 7 2-4 1)"
token_quote "${args[@]}"
)"
# Test that any args with spaces remain quoted
assertEquals "$error" '-m Test\ Commit\ Message one' \
"$(eval args="$(scmb_expand_args -m "Test Commit Message" 1)"; token_quote "${args[@]}")"
"$(
eval args="$(scmb_expand_args -m "Test Commit Message" 1)"
token_quote "${args[@]}"
)"
assertEquals "$error" '-ma Test\ Commit\ Message Unquoted' \
"$(eval args="$(scmb_expand_args -ma "Test Commit Message" "Unquoted")"; token_quote "${args[@]}")"
"$(
eval args="$(scmb_expand_args -ma "Test Commit Message" "Unquoted")"
token_quote "${args[@]}"
)"
assertEquals "$error" '\$dollar one two\ words' \
"$(eval args="$(scmb_expand_args 7 1-1 8)"; token_quote "${args[@]}")"
"$(
eval args="$(scmb_expand_args 7 1-1 8)"
token_quote "${args[@]}"
)"
# Keep this code for use when minimum versions of {ba,z}sh can be increased.
# See token_quote() source and https://github.com/scmbreeze/scm_breeze/issues/260
@@ -89,14 +110,23 @@ test_scmb_expand_args() {
test_exec_scmb_expand_args() {
local e1="one" e2="a b c" e3='$dollar' e4="single'quote" e5='double"quote' e6='a(){:;};a&'
assertEquals "literals with spaces not preserved" 'foo bar\ baz' \
"$(eval args="$(scmb_expand_args foo 'bar baz')"; token_quote "${args[@]}")"
"$(
eval args="$(scmb_expand_args foo 'bar baz')"
token_quote "${args[@]}"
)"
assertEquals "variables with spaces not preserved" 'one a\ b\ c' \
"$(eval args="$(scmb_expand_args 1-2)"; token_quote "${args[@]}")"
"$(
eval args="$(scmb_expand_args 1-2)"
token_quote "${args[@]}"
)"
# Expecting text: '$dollar' "single'quote" 'double"quote'
# Generate quoted expected string with: token_quote "$(cat)" then copy/paste, ^D
assertEquals "special characters are preserved" \
'\$dollar single\'\''quote double\"quote a\(\)\{:\;\}\;a\&' \
"$(eval args="$(scmb_expand_args 3-6)"; token_quote "${args[@]}")"
"$(
eval args="$(scmb_expand_args 3-6)"
token_quote "${args[@]}"
)"
# Keep this code for use when minimum versions of {ba,z}sh can be increased.
# See token_quote() source and https://github.com/scmbreeze/scm_breeze/issues/260
@@ -202,7 +232,6 @@ test_git_status_produces_relative_paths() {
assertIncludes "$git_status" "../../../dir2/testfile" || return
}
test_git_status_shortcuts_merge_conflicts() {
setupTestRepo
@@ -247,7 +276,6 @@ test_git_status_shortcuts_merge_conflicts() {
assertIncludes "$git_status" "added by us: *\[[0-9]*\] *renamed_file_on_master" || return
}
test_git_status_shortcuts_max_changes() {
setupTestRepo
@@ -269,7 +297,6 @@ test_git_status_shortcuts_max_changes() {
export gs_max_changes="20"
}
test_git_add_shortcuts() {
setupTestRepo
@@ -310,12 +337,14 @@ test_git_commit_prompt() {
# Test that history was appended correctly.
if [[ $shell == "zsh" ]]; then
test_history="$(history)"
# TODO(ghthor): zsh isn't working here
# assertIncludes "$test_history" "git commit -m \"$dbl_escaped_msg\""
else
# Need to load history from $HISTFILE
# (Couldn't get the 'history' builtin to work during tests.)
test_history="$(cat $HISTFILE)"
fi
assertIncludes "$test_history" "git commit -m \"$dbl_escaped_msg\""
fi
}
test_git_commit_prompt_with_append() {
@@ -324,9 +353,9 @@ test_git_commit_prompt_with_append() {
commit_msg="Updating README, no build please"
# Create temporary history file
HISTFILE=$(mktemp -t scm_breeze.XXXXXXXXXX)
HISTFILESIZE=1000
HISTSIZE=1000
export HISTFILE=$(mktemp -t scm_breeze.XXXXXXXXXX)
export HISTFILESIZE=1000
export HISTSIZE=1000
touch a b c
git add . >/dev/null
@@ -344,11 +373,14 @@ test_git_commit_prompt_with_append() {
# Test that history was appended correctly.
if [[ $shell == "zsh" ]]; then
test_history="$(history)"
# TODO(ghthor): zsh isn't working here
# assertIncludes "$test_history" "$commit_msg \[ci skip\]"
# assertIncludes "$test_history" "git commit -m \"$commit_msg \[ci skip\]\""
else
test_history="$(cat $HISTFILE)"
fi
assertIncludes "$test_history" "$commit_msg \[ci skip\]"
assertIncludes "$test_history" "git commit -m \"$commit_msg \[ci skip\]\""
fi
}
test_adding_files_with_spaces() {
@@ -365,7 +397,5 @@ test_adding_files_with_spaces() {
assertIncludes "$git_status" "new file: \[1\] \"$test_file"
}
# load and run shUnit2
source "$scmbDir/test/support/shunit2"

View File

@@ -1,32 +0,0 @@
#!/usr/bin/env bash
# Installs dependencies for travis-ci environments.
# Install dependencies, which looks to be just bash & zsh.
#
# Darwin has zsh preinstalled already, so only need to install on Ubuntu.
#
# Note: $TRAVIS_OS_NAME will only be set on text boxes with multi-os enabled,
# so use negation test so it will fail gracefully on normal Travis linux setup.
if [[ "$TRAVIS_OS_NAME" != "osx" ]]; then
# okay, so we know we're probably on a linux box (or at least not an osx box)
# at this point. do we need to install zsh? let's say the default case is no:
needs_zsh=false
# check if zsh is listed in the TEST_SHELLS environment variable, set by
# our travis-ci build matrix.
if [[ $TEST_SHELLS =~ zsh ]]; then needs_zsh=true; fi
# if there is NO $TEST_SHELLS env variable persent (which should never happen,
# but maybe someone has been monkeying with the .travis.yml), run_tests.sh is
# going to fall back onto the default of testing everything, so we need zsh.
if [[ -z "$TEST_SHELLS" ]]; then needs_zsh=true; fi
# finally, we install zsh if needed!
if $needs_zsh; then
sudo apt-get update
sudo apt-get install zsh
else
echo "No deps required."
fi
fi