Merge pull request #5 from tommarshall/add-support-for-cached-option

Add support for cached option

Author: tommarshall

README.md

@@ -39,6 +39,7 @@ $ git diff-ansible-vault -h
 ```
     -r, --revision <revision>          show diff for git revision, e.g. master..some-branch
     -p, --path <path>                  restrict diff to path, e.g. support/config.yml
+        --cached, --staged             show diff for staged changes
         --vault-password-file <path>   vault password file path, defaults to .vault-pass
         --vault-only                   restrict diff to vault files only
         --color, --colour              turn on coloured output

bin/git-diff-ansible-vault

@@ -7,9 +7,10 @@
 # https://github.com/tommarshall/git-diff-ansible-vault
 #
 
-VERSION=0.1.0
+VERSION=0.2.0
 REVISION=
 PATH_SCOPE=
+GIT_DIFF_ARGS=
 VAULT_PASSWORD_FILE='./.vault-pass'
 VAULT_ONLY=0
 COLOR=
@@ -50,6 +51,7 @@ help() {
   Options:
     -r, --revision <revision>          show diff for git revision, e.g. master..some-branch
     -p, --path <path>                  restrict diff to path, e.g. support/config.yml
+        --cached, --staged             show diff for staged changes
         --vault-password-file <path>   vault password file path, defaults to .vault-pass
         --vault-only                   restrict diff to vault files only
         --color, --colour              turn on coloured output
@@ -233,23 +235,24 @@ set_default_color() {
 git_diff_ansible_vault() {
   log "REVISION: $REVISION"
   log "PATH_SCOPE: $PATH_SCOPE"
+  log "GIT_DIFF_ARGS: $GIT_DIFF_ARGS"
   log "VAULT_PASSWORD_FILE: $VAULT_PASSWORD_FILE"
   log "VAULT_ONLY: $VAULT_ONLY"
   log "COLOR: $COLOR"
 
-  for FILE_PATH in $($GIT_CMD diff --name-only $REVISION $PATH_SCOPE); do
+  for FILE_PATH in $($GIT_CMD diff $GIT_DIFF_ARGS --name-only $REVISION $PATH_SCOPE); do
     if is_vault $FILE_PATH; then
       log "$FILE_PATH is vault"
       # extract the old revision encrypted file contents
-      local old=$($GIT_CMD diff $REVISION $FILE_PATH \
+      local old=$($GIT_CMD diff $GIT_DIFF_ARGS $REVISION $FILE_PATH \
         | grep -E '^-[^-]|\$ANSIBLE_VAULT' | sed -E 's/^([^- ]*)[- ]/\1/')
 
       # extract the new revision encrypted file contents
-      local new=$($GIT_CMD diff $REVISION $FILE_PATH \
+      local new=$($GIT_CMD diff $GIT_DIFF_ARGS $REVISION $FILE_PATH \
         | grep -E '^\+[^\+]|\$ANSIBLE_VAULT' | sed -E 's/^([^+ ]*)[+ ]/\1/')
 
       # print the diff heading from git diff so we get the real paths
-      $GIT_CMD -c color.ui=$COLOR diff $REVISION $FILE_PATH | head -n 4
+      $GIT_CMD -c color.ui=$COLOR diff $GIT_DIFF_ARGS $REVISION $FILE_PATH | head -n 4
 
       # print the diff body from the opened vault diff
       diff -u \
@@ -258,7 +261,7 @@ git_diff_ansible_vault() {
         | tail -n +3 | colordiff_wrap
     elif [ $VAULT_ONLY -eq 0 ]; then
       log "$FILE_PATH is not vault"
-      $GIT_CMD -c color.ui=$COLOR diff $REVISION $FILE_PATH
+      $GIT_CMD -c color.ui=$COLOR diff $GIT_DIFF_ARGS $REVISION $FILE_PATH
     fi
   done
 }
@@ -272,6 +275,7 @@ while test $# -ne 0; do
   case $ARG in
     -r|--revision) REVISION=$1; shift ;;
     -p|--path) PATH_SCOPE=$1; shift ;;
+    --cached|--staged) GIT_DIFF_ARGS="$GIT_DIFF_ARGS --cached" ;;
     --vault-password-file) set_vault_password_file_path $1; shift ;;
     --vault-only) VAULT_ONLY=1 ;;
     --color|--colour) ensure_colordiff; COLOR='always' ;;

test/fixture/repo.git/git/index

@@ -6,4 +6,5 @@ fruits:
   - Strawberry
   - Mango
   - Banana
+  - Pineapple
   - Peach

test/fixture/repo.git/git/objects/49/7da2b1aee4bddd2cf263adf0e97fba1384b286

@@ -1,18 +1,18 @@
 $ANSIBLE_VAULT;1.1;AES256
-34643163373064663534393164356661373631326239666236343634636264393465326330636433
-3562333137656266636330306366663634376439376437370a333430366636346434653331303830
-66306665316338663563666663373234613263663337636464303962643232633733656263633939
-6335376631333265320a303039303061613735326634396230336333393632386164653438316539
-39353736613264336166623965663236373565623736383936636133656131316562646236366463
-64303538363864336438656533393165313064643264313730316163623332323163613139306639
-38376364313332616137396532656135353962353939346339653333383936653439636335613865
-38336266306432326338396566653033653066666261646662383463663936356637373131663265
-37643530646265613734323136626433646466653932376162626635353438333463666261366564
-35343264396161323230613862626331636431316135636365313764666164346639333937613233
-30336333313536313037323433656466326333353133356137366661666232333830363534336133
-38376535316430343035393331666438393333666234346336303334623261323261326439313961
-31343832373634383030393766303334653937383163366332656436653565643365393638303161
-62656337393762316362323934373439363163613961623238323135353663636266323865616163
-38633531363664663430666435663339313932363363613135323131326162303463363164316530
-36616538353265383031646339623237393062333838643037346335353338313065323737383933
-3132
+66326137633863336537383736396238386230383731383937633936373264353339613939326532
+3736626665353833336330626464653631343536316135310a303464383230333866653432366539
+62363935303930383365656232383033343735656566366162333165346639626635316536643334
+6138313766376364390a313135393835316564636566353432336165383632363039626331613037
+63626265303939666239323036636131653332363763616437323562623462323833393833616136
+33373631323863363137373566356266646434366236376437303565656165396234616161323238
+31643339666263323564616136373065616331376435343466366339373766623031303139393234
+35366632303635313466636632313233643262623461663463333136346437616264636234353932
+36656464396534396364633437653835643333363961323139333463663836663864333563643837
+33316532333237303834393337646236663265633465393066653766393164646566363162666566
+37333734393963396666633137366164353665396636343337303365336539663936343638326664
+33366464643864343066306165633232623230323731323630303066613138646666343263363939
+38313238336135376432663164326365616638633665383663666664396131393733353731636666
+33366630303031653039336231653339623933363635333431643539613831316138343966386339
+34633636303965666138373264333934326139656563353638306135383135643865336536383365
+66333134353862613739653332643731666138346137663135306261613331373434356564656231
+3562

test/fixture/repo.git/git/objects/4a/3c07165f2dd4ecf6a1306a0b288814caefac2c

@@ -19,19 +19,19 @@ teardown() {
   assert_success
   assert_output "$(cat <<EOF
 diff --git a/public.yml b/public.yml
-index 1f613c2..4e1e398 100644
+index 497da2b..bb68218 100644
 --- a/public.yml
 +++ b/public.yml
-@@ -6,3 +6,4 @@ fruits:
-   - Strawberry
+@@ -7,3 +7,4 @@ fruits:
    - Mango
    - Banana
+   - Pineapple
 +  - Peach
 diff --git a/vault.yml b/vault.yml
-index 5fd6cf8..6b45548 100644
+index ff6110d..f5b9bd7 100644
 --- a/vault.yml
 +++ b/vault.yml
-@@ -15,3 +15,4 @@
+@@ -16,3 +16,4 @@
      - lisp
      - fortran
      - erlang
@@ -74,10 +74,10 @@ EOF
   assert_success
   assert_output "$(cat <<EOF
 diff --git a/vault.yml b/vault.yml
-index 5fd6cf8..6b45548 100644
+index ff6110d..f5b9bd7 100644
 --- a/vault.yml
 +++ b/vault.yml
-@@ -15,3 +15,4 @@
+@@ -16,3 +16,4 @@
      - lisp
      - fortran
      - erlang
@@ -106,6 +106,36 @@ EOF
 )"
 }
 
+@test "with --staged shows all staged changes" {
+  run git diff-ansible-vault --staged
+  assert_success
+  echo "$output" > "$BATS_TEST_DIRNAME/../output.log"
+  assert_output "$(cat <<EOF
+diff --git a/public.yml b/public.yml
+index 1f613c2..497da2b 100644
+--- a/public.yml
++++ b/public.yml
+@@ -6,3 +6,4 @@ fruits:
+   - Strawberry
+   - Mango
+   - Banana
++  - Pineapple
+diff --git a/vault.yml b/vault.yml
+index 5fd6cf8..ff6110d 100644
+--- a/vault.yml
++++ b/vault.yml
+@@ -8,6 +8,7 @@
+     - perl
+     - pascal
+     - ruby
++    - go
+ - tabitha:
+   name: Tabitha Bitumen
+   job: Developer
+EOF
+)"
+}
+
 @test "without a git repository exits with an error" {
   cd /tmp && touch .vault-pass
   run git diff-ansible-vault
@@ -136,10 +166,10 @@ EOF
   assert_success
   assert_output "$(cat <<EOF
 diff --git a/vault.yml b/vault.yml
-index 5fd6cf8..6b45548 100644
+index ff6110d..f5b9bd7 100644
 --- a/vault.yml
 +++ b/vault.yml
-@@ -15,3 +15,4 @@
+@@ -16,3 +16,4 @@
      - lisp
      - fortran
      - erlang