Skip to content

Commit

Permalink
Finish first half of Bats tests
Browse files Browse the repository at this point in the history
  • Loading branch information
hyperupcall committed Nov 29, 2024
1 parent 88615ce commit de55275
Show file tree
Hide file tree
Showing 6 changed files with 304 additions and 76 deletions.
8 changes: 8 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,11 @@ trim_trailing_whitespace = false

[*.py]
indent_size = 4

[*.bats]
indent_style = tab
indent_size = 4

[tests/*.sh]
indent_style = tab
indent_size = 4
124 changes: 77 additions & 47 deletions tests/git-abort.bats
Original file line number Diff line number Diff line change
Expand Up @@ -3,61 +3,91 @@
source "$BATS_TEST_DIRNAME/test_util.sh"

setup_file() {
test_util.setup_file
test_util.setup_file
}

# This is ran before each "@test".
setup() {
# cd's to a temporary directory that is unique for each "@test".
test_util.cd_test

# Do initialization (this code is copied from test_git_alias.py)
git init
git config --global alias.globalalias status
git config --global alias.x status
git config --local alias.localalias status
git config --local alias.y status
test_util.cd_test

git init
git commit --allow-empty -m "Initial commit"
git branch A
git branch B
git checkout A
printf '%s\n' 'a' > tmpfile
git add .
git commit -m A
git checkout B
printf '%s\n' 'b' > tmpfile
git add .
git commit -m B
git status
}

@test "cherry pick" {
run git cherry-pick A
assert_failure

run git status
assert_line -p 'You are currently cherry-picking commit'
assert_line -p 'Unmerged paths:'
assert_success

run git abort
assert_success

run git status
assert_line -p 'nothing to commit, working tree clean'
assert_success
}

@test "merge" {
run git merge A
assert_failure

run git status
assert_line -p 'You have unmerged paths'
assert_line -p 'Unmerged paths:'
assert_success

run git abort
assert_success

run git status
assert_line -p 'nothing to commit, working tree clean'
assert_success
}

@test "list all works" {
run git alias

# This is one way to do it, most similar to the "test_list_all" test in
# test_git_alias.py. It's slightly more accurate because each substring
# must match a particular line of output (rather than matching any part of the output)
assert_line 'globalalias = status'
assert_line 'x = status'
assert_line 'localalias = status'
assert_line 'y = status'

# To test the full output, this is one way:
assert_output 'globalalias = status
localalias = status
x = status
y = status'

# One can use heredocs to also achieve this, which makes the test look a little nicer. Note that the indentation MUST BE DONE WITH TABS.
assert_output - <<-"EOF"
globalalias = status
localalias = status
x = status
y = status
EOF

# I tend to put 'assert_success' at the bottom. This usually makes debugging easier because an "assert_output" written above will usuall fail first. This will cause the the output of the run command to be printed (instead of just the exit code).
# The downside to this is that sometimes there is a bug: An error "lines: parameter not set" will be shown instead (which is a Bats issue).
assert_success
@test "rebase" {
run git rebase A
assert_failure

run git status
assert_line -p 'You are currently rebasing branch'
assert_line -p 'Unmerged paths:'
assert_success

run git abort
assert_success

run git status
assert_line -p 'nothing to commit, working tree clean'
assert_success
}

@test "list all global works" {
run git alias --global
@test "revert" {
run git revert A
assert_failure

# One debugging technique for bats test I've found useful is to redirect to
# fd3. The variable "$output" is set by Bats, and it is the output of the previous "run" command (in this case, `git alias --global`). Here, we are printing it to fd3 for debugging. Naturally, be sure to run `exec 3>&1` (assuming you are running Bash or Zsh shell) in the terminal before running Bats.
# echo "$output" >&3
run git status
assert_line -p 'You are currently reverting commit'
assert_line -p 'Unmerged paths:'
assert_success

run git abort
assert_success

assert_output 'globalalias = status
x = status'
assert_success
run git status
assert_line -p 'nothing to commit, working tree clean'
assert_success
}
99 changes: 92 additions & 7 deletions tests/git-alias.bats
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,104 @@
source "$BATS_TEST_DIRNAME/test_util.sh"

setup_file() {
test_util.setup_file
test_util.setup_file
}

setup() {
test_util.cd_test
test_util.cd_test

# Any extra setup goes here.
git init
git config --global alias.globalalias status
git config --global alias.x status
git config --local alias.localalias status
git config --local alias.y status
}

@test "blah 1" {
:
@test "list all works" {
run git alias
assert_output - <<-'EOF'
globalalias = status
localalias = status
x = status
y = status
EOF
assert_success
}

@test "blah 2" {
:
@test "list all globally works" {
run git alias --global
assert_output - <<-'EOF'
globalalias = status
x = status
EOF
assert_success
}

@test "list all locally works" {
run git alias --local
assert_output - <<-'EOF'
localalias = status
y = status
EOF
assert_success
}

@test "search globally works" {
run git alias --global global
assert_output - <<-'EOF'
globalalias = status
EOF
assert_success

run git alias --global local
assert_output ''
assert_failure
}

@test "search locally works" {
run git alias --local local
assert_output - <<-'EOF'
localalias = status
EOF
assert_success

run git alias --local global
assert_output ''
assert_failure
}

@test "get alias globally and defaultly" {
run git alias globalalias
assert_output - <<-'EOF'
globalalias = status
EOF
assert_success
}

@test "set alias globally and defaultly" {
git alias globalalias diff
run git alias diff
assert_output - <<-'EOF'
globalalias = diff
EOF
assert_success
}

@test "get alias locally" {
run git alias --local localalias
assert_output - <<-'EOF'
localalias = status
EOF
assert_success
}

@test "set alias locally" {
git alias --local localalias diff
run git alias
assert_output - <<-'EOF'
globalalias = status
localalias = diff
x = status
y = status
EOF
}
66 changes: 66 additions & 0 deletions tests/git-archive-file.bats
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# shellcheck shell=bash

source "$BATS_TEST_DIRNAME/test_util.sh"

setup_file() {
test_util.setup_file
}

setup() {
test_util.cd_test

git init
printf '%s\n' 'data' > tmpfile
git add .
git commit -m 'test: add data'
git tag 0.1.0 -m 'bump: 0.1.0'
}

@test "archive file on tags branch" {
git checkout -b tags0.1.0
run git archive-file
assert_success

local describe_output=
describe_output=$(git describe)
assert_file_exists "${PWD##*/}.$describe_output.zip"
}

@test "archive file on any not tags branch without default branch" {
git checkout -b not-tags-branch
run git archive-file
assert_success

local describe_output=
describe_output=$(git describe --always --long)
assert_file_exists "${PWD##*/}.$describe_output.not-tags-branch.zip"
}

@test "archive file on any not tags branch with default branch" {
skip "Not working as expected"

run git archive-file
assert_success

local describe_output=
describe_output=$(git describe --always --long)
assert_file_exists "${PWD##*/}.$describe_output.zip"
}

@test "archive file on branch name has slash" {
git checkout -b feature/slash
run git archive-file
assert_success

local describe_output=
describe_output=$(git describe --always --long)
assert_file_exists "${PWD##*/}.$describe_output.feature-slash.zip"
}

@test "archive file on dirname has backslash" {
skip
}

@test "archive file on tag name has slash" {
skip
}
52 changes: 52 additions & 0 deletions tests/git-authors.bats
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# shellcheck shell=bash

source "$BATS_TEST_DIRNAME/test_util.sh"


setup_file() {
test_util.setup_file
}

setup() {
test_util.cd_test

git init
git config --local user.name test
git config --local user.email [email protected]
printf '%s\n' 'A' > tmpfile
git add .
git commit -m 'test: add data A'
git config --local user.name testagain
git config --local user.email [email protected]
printf '%s\n' 'B' > tmpfile
git add .
git commit -m 'test: add data B'
}

@test "output authors has email without any parameter" {
run git authors
assert_success

local content=$(<AUTHORS)
assert_equal "$content" $'test <[email protected]>\ntestagain <[email protected]>'
}

@test "list authors has email defaultly" {
run git authors --list
assert_output $'test <[email protected]>\ntestagain <[email protected]>'
assert_success

run git authors -l
assert_output $'test <[email protected]>\ntestagain <[email protected]>'
assert_success
}

@test "list authors has no email" {
run git authors --list --no-email
assert_output $'test\ntestagain'
assert_success

run git authors -l --no-email
assert_output $'test\ntestagain'
assert_success
}
Loading

0 comments on commit de55275

Please sign in to comment.