Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

git-secret-changes use of echo adds a newline #291

Closed
BrandonCsSanders opened this issue Dec 28, 2018 · 4 comments
Closed

git-secret-changes use of echo adds a newline #291

BrandonCsSanders opened this issue Dec 28, 2018 · 4 comments
Assignees
@joshrabinowitz
Labels
bug

Comments

@BrandonCsSanders
Copy link

What are the steps to reproduce this issue?

  1. don't change FILE.pem.secret
  2. run git-secret changes FILE.pem.secret

What happens?

git-secret changes shows that a newline at the end of the file was removed

--- /dev/fd/63	2018-12-28 08:43:13.000000000 -0800
+++ FILE.pem	2018-12-27 17:37:37.000000000 -0800
@@ -20,4 +20,4 @@
ASDFASDFASDFADFSADFSAFSDASDF...elided...
+-----END RSA PRIVATE KEY-----
\ No newline at end of file

What were you expecting to happen?

no changes

Any logs, error output, etc?

    diff_result=$(diff -u <(echo "$decrypted") "$path") || true

Should instead be

    diff_result=$(diff -u <(echo -n "$decrypted") "$path") || true

What versions of software are you using?

0.2.4
@sobolevn
Copy link
Owner

@BrandonCsSanders thanks for the bug report! Can you please send a PR with the fix?

BrandonCsSanders added a commit to BrandonCsSanders/git-secret that referenced this issue Dec 28, 2018
@BrandonCsSanders
Fixes sobolevn#291 ... remove extra changes newline
8789269
@BrandonCsSanders BrandonCsSanders mentioned this issue Dec 28, 2018
Closed
BrandonCsSanders added a commit to BrandonCsSanders/git-secret that referenced this issue Dec 28, 2018
@BrandonCsSanders
No extra newline on git-secret-changes … fix sobolevn#291
1700b0f
BrandonCsSanders added a commit to BrandonCsSanders/git-secret that referenced this issue Dec 28, 2018
@BrandonCsSanders
Remove echo whitespace on changes … Fixes sobolevn#291
9c062ec
@joshrabinowitz joshrabinowitz mentioned this issue Dec 29, 2018
Merged
@joshrabinowitz
Copy link
Collaborator

joshrabinowitz commented Dec 30, 2018 •
edited

I see what's going on here.

The underlying issue is that the $() construct used in decrypted=$(_decrypt "$path" "0" "0" "$homedir" "$passphrase") (and other places) removes trailing newlines.

So the 'right' thing to do is to get compare the output from _decrypt without stripping trailing newlines. (And use echo -n as you show).

@joshrabinowitz
Copy link
Collaborator

@BrandonCsSanders I've worked up a solution with tests for this issue at #293

@joshrabinowitz joshrabinowitz self-assigned this Jan 1, 2019
joshrabinowitz added a commit that referenced this issue Jan 1, 2019
@joshrabinowitz
Fixes for 'changes' and trailing newlines, for #291 (#293)
913d026 
* tests and comments about 'changes' for #291
* add 'changes' tests, improve diagnostic 
* preserve trailing newlines in diff output
* use bash trickery to preserve trailing newlines in captured text
* test 'changes' on files without newlines and when called on a non-existant file
* improve comments and variable names
@joshrabinowitz
Copy link
Collaborator

Fixed in #293

joshrabinowitz added a commit that referenced this issue Jan 3, 2019
@joshrabinowitz
reorder entries, add note #291 being fixed (#295)
4aa7dd2
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@joshrabinowitz joshrabinowitz

Labels
bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Remove extra newline on changes BrandonCsSanders/git-secret
3 participants
@joshrabinowitz @sobolevn @BrandonCsSanders