Skip to content

Comments

fix: dir no longer panics when HOME and XDG_CONFIG_HOME are not set#449

Merged
JeyJeyGao merged 16 commits intonotaryproject:mainfrom
JasonTheDeveloper:fix/446-init-panic
Sep 4, 2024
Merged

fix: dir no longer panics when HOME and XDG_CONFIG_HOME are not set#449
JeyJeyGao merged 16 commits intonotaryproject:mainfrom
JasonTheDeveloper:fix/446-init-panic

Conversation

@JasonTheDeveloper
Copy link
Contributor

@JasonTheDeveloper JasonTheDeveloper commented Sep 2, 2024

This PR addresses the issue #446

In this PR I:

  • I removed the init() function from dir/path
  • When userConfigDir() returns an error, instead of panic(err) I default to the current directory instead
  • Split loadUserPath() into two new functions used to setup and return the values for UserConfigDir and UserLibexecDir
  • Added additional unit tests for the two new functions and to test the default directory is used when HOME is set to ""

@JasonTheDeveloper JasonTheDeveloper requested a review from a user September 2, 2024 09:06
@JasonTheDeveloper JasonTheDeveloper force-pushed the fix/446-init-panic branch 2 times, most recently from a02efc9 to e816f4b Compare September 2, 2024 11:47
JeyJeyGao
JeyJeyGao reviewed Sep 2, 2024
View reviewed changes
@codecov
Copy link

codecov bot commented Sep 3, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.98%. Comparing base (115509e) to head (5f6bf77).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #449      +/-   ##
==========================================
+ Coverage   80.86%   80.98%   +0.11%     
==========================================
  Files          33       33              
  Lines        2483     2487       +4     
==========================================
+ Hits         2008     2014       +6     
+ Misses        332      331       -1     
+ Partials      143      142       -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

JeyJeyGao
JeyJeyGao previously approved these changes Sep 3, 2024
View reviewed changes
Copy link
Contributor

@JeyJeyGao JeyJeyGao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

shizhMSFT
shizhMSFT reviewed Sep 3, 2024
View reviewed changes
@ghost ghost linked an issue Sep 3, 2024 that may be closed by this pull request
Bug: Notation panics on init when $HOME and $XDG_CONFIG_HOME unset #446
Closed
shizhMSFT
shizhMSFT approved these changes Sep 3, 2024
View reviewed changes
Copy link
Contributor

@shizhMSFT shizhMSFT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

ghost
ghost approved these changes Sep 3, 2024
View reviewed changes
Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

JeyJeyGao
JeyJeyGao approved these changes Sep 3, 2024
View reviewed changes
Copy link
Contributor

@JeyJeyGao JeyJeyGao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@JasonTheDeveloper JasonTheDeveloper mentioned this pull request Sep 3, 2024
Closed
@stefanprodan stefanprodan mentioned this pull request Sep 3, 2024
Closed
@JeyJeyGao
Copy link
Contributor

JeyJeyGao commented Sep 3, 2024

@JasonTheDeveloper

The base branch requires all commits to be signed

You need to fix it.

@JasonTheDeveloper
Copy link
Contributor Author

JasonTheDeveloper commented Sep 3, 2024 •
edited
Loading

@JasonTheDeveloper

The base branch requires all commits to be signed

You need to fix it.

@JeyJeyGao All my commits are signed though? DCO also passed the sign off checks. Not sure why GitHub is saying The base branch requires all commits to be signed.

image

priteshbandi
priteshbandi reviewed Sep 4, 2024
View reviewed changes
Copy link
Contributor

@priteshbandi priteshbandi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@JasonTheDeveloper JasonTheDeveloper force-pushed the fix/446-init-panic branch 3 times, most recently from 7e26ba3 to 05b532f Compare September 4, 2024 05:50
JasonTheDeveloper and others added 15 commits September 4, 2024 16:47
@JasonTheDeveloper
refactor(dir): remove init from package
34ede59 
Signed-off-by: Jason <jagoodse@microsoft.com>
@JasonTheDeveloper
refactor(dir): split loadUserPath into two functions
87a2264 
Signed-off-by: Jason <jagoodse@microsoft.com>
@JasonTheDeveloper
fix(dir): remove panic and instead default to current directory
d6a685b 
Signed-off-by: Jason <jagoodse@microsoft.com>
@JasonTheDeveloper
test(dir): add unit test for new functions
7b829bd 
Signed-off-by: Jason <jagoodse@microsoft.com>
@JasonTheDeveloper
refactor(fs): use new functions for retrieving paths
a08bba7 
Signed-off-by: Jason <jagoodse@microsoft.com>
@JasonTheDeveloper
test(dir): test unset HOME
aaa72ee 
Signed-off-by: Jason <jagoodse@microsoft.com>
@JasonTheDeveloper
test(dir): fix failing unit test
5e2e5f6 
Signed-off-by: Jason <jagoodse@microsoft.com>
@JasonTheDeveloper
refactor(dir): convert function to be internal
bbe7961 
Signed-off-by: Jason <jagoodse@microsoft.com>
@JasonTheDeveloper
test(dir): unset XDG_CONFIG_HOME
0f0e316 
Signed-off-by: Jason <jagoodse@microsoft.com>
@JasonTheDeveloper
refactor(dir): remove loadUserPath func
290f0c3 
Signed-off-by: Jason <jagoodse@microsoft.com>
@JasonTheDeveloper
refactor(dir): set default directory to .notation
7a10e72 
Signed-off-by: Jason <jagoodse@microsoft.com>
@JasonTheDeveloper @shizhMSFT
refactor(dir): remove userDir
98f0fd2 
Co-authored-by: Shiwei Zhang <shizh@microsoft.com>
Signed-off-by: JasonTheDeveloper <jagoodse@microsoft.com>
Signed-off-by: Jason <jagoodse@microsoft.com>
@JasonTheDeveloper
refactor(dir): remove redundant code
e5b04e7 
Signed-off-by: Jason <jagoodse@microsoft.com>
@JasonTheDeveloper
docs: create release checklist on main (notaryproject#443)
51acb0b 
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
Signed-off-by: Jason <jagoodse@microsoft.com>
@JasonTheDeveloper
bump: bump up notation-core-go and signingAgent (notaryproject#444)
ff67f65 
This PR targets on main branch.

---------

Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
Signed-off-by: Jason <jagoodse@microsoft.com>
@JeyJeyGao JeyJeyGao merged commit 4d76f9a into notaryproject:main Sep 4, 2024
@JasonTheDeveloper JasonTheDeveloper deleted the fix/446-init-panic branch September 4, 2024 07:06
JeyJeyGao pushed a commit to JeyJeyGao/notation-go that referenced this pull request Sep 4, 2024
@JasonTheDeveloper @shizhMSFT @JeyJeyGao
fix: dir no longer panics when HOME and XDG_CONFIG_HOME are not set (n…
eb08659 
…otaryproject#449)

This PR addresses the issue notaryproject#446

In this PR I:

- I removed the `init()` function from `dir/path`
- When `userConfigDir()` returns an error, instead of `panic(err)` I
default to the current directory instead
- Split `loadUserPath()` into two new functions used to setup and return
the values for `UserConfigDir` and `UserLibexecDir`
- Added additional unit tests for the two new functions and to test the
default directory is used when `HOME` is set to `""`

---------

Signed-off-by: Jason <jagoodse@microsoft.com>
Signed-off-by: JasonTheDeveloper <jagoodse@microsoft.com>
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
Co-authored-by: Shiwei Zhang <shizh@microsoft.com>
Co-authored-by: Patrick Zheng <patrickzheng@microsoft.com>
JeyJeyGao pushed a commit to JeyJeyGao/notation-go that referenced this pull request Sep 4, 2024
@JasonTheDeveloper @shizhMSFT @JeyJeyGao
fix: dir no longer panics when HOME and XDG_CONFIG_HOME are not set (n…
73b4bf6 
…otaryproject#449)

This PR addresses the issue notaryproject#446

In this PR I:

- I removed the `init()` function from `dir/path`
- When `userConfigDir()` returns an error, instead of `panic(err)` I
default to the current directory instead
- Split `loadUserPath()` into two new functions used to setup and return
the values for `UserConfigDir` and `UserLibexecDir`
- Added additional unit tests for the two new functions and to test the
default directory is used when `HOME` is set to `""`

---------

Signed-off-by: Jason <jagoodse@microsoft.com>
Signed-off-by: JasonTheDeveloper <jagoodse@microsoft.com>
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
Co-authored-by: Shiwei Zhang <shizh@microsoft.com>
Co-authored-by: Patrick Zheng <patrickzheng@microsoft.com>
JeyJeyGao added a commit that referenced this pull request Sep 5, 2024
@JeyJeyGao @JasonTheDeveloper @shizhMSFT
fix: dir no longer panics when HOME and XDG_CONFIG_HOME are not set (#…
e6c7fef 
…449)  (#450)

This PR addresses the issue
#446 for
`release-1.1` branch
This commit was cherry picked from commit
4d76f9a


In this PR I:

- I removed the `init()` function from `dir/path`
- When `userConfigDir()` returns an error, instead of `panic(err)` I
default to the current directory instead
- Split `loadUserPath()` into two new functions used to setup and return
the values for `UserConfigDir` and `UserLibexecDir`
- Added additional unit tests for the two new functions and to test the
default directory is used when `HOME` is set to `""`

Signed-off-by: Jason <jagoodse@microsoft.com>
Signed-off-by: JasonTheDeveloper <jagoodse@microsoft.com>
Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
Co-authored-by: JasonTheDeveloper <jagoodse@microsoft.com>
Co-authored-by: Shiwei Zhang <shizh@microsoft.com>
Co-authored-by: Patrick Zheng <patrickzheng@microsoft.com>
@JeyJeyGao JeyJeyGao mentioned this pull request Sep 5, 2024
Merged
6 tasks
JeyJeyGao added a commit that referenced this pull request Sep 9, 2024
@JeyJeyGao
bump: release v1.1.2 (#453)
99da555 
## Release

This would mean tagging 595c710
`v1.1.2` to release.

## Vote

We need at least `4` approvals from `6` maintainers to release
`notation-go v1.1.2`.

- [x] Pritesh Bandi (@priteshbandi)
- [x] Junjie Gao (@JeyJeyGao)
- [ ] Rakesh Gariganti (@rgnote)
- [ ] Milind Gokarn (@gokarnm)
- [x] Shiwei Zhang (@shizhMSFT)
- [x] Patrick Zheng (@Two-Hearts)


## What's Changed
* fix&bump: maintenance update for branch `release-1.1` by @JeyJeyGao in
#448
* fix: dir no longer panics when HOME and XDG_CONFIG_HOME are not set
(#449) by @JeyJeyGao in
#450


**Full Changelog**:
v1.1.1...595c710

## Actions

Please review the PR and vote by approving.

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
@JeyJeyGao JeyJeyGao mentioned this pull request Sep 9, 2024
Closed
6 tasks
@ghost ghost mentioned this pull request Sep 27, 2024
Merged
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@priteshbandi priteshbandi priteshbandi approved these changes

@shizhMSFT shizhMSFT shizhMSFT approved these changes

@gokarnm gokarnm Awaiting requested review from gokarnm gokarnm is a code owner

@NiazFK NiazFK Awaiting requested review from NiazFK NiazFK is a code owner

@rgnote rgnote Awaiting requested review from rgnote rgnote is a code owner

@toddysm toddysm Awaiting requested review from toddysm toddysm is a code owner

@vaninrao10 vaninrao10 Awaiting requested review from vaninrao10 vaninrao10 is a code owner

@yizha1 yizha1 Awaiting requested review from yizha1 yizha1 is a code owner

+2 more reviewers

@JeyJeyGao JeyJeyGao JeyJeyGao approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Bug: Notation panics on init when $HOME and $XDG_CONFIG_HOME unset

5 participants

@JasonTheDeveloper @JeyJeyGao @priteshbandi @shizhMSFT @yizha1