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.

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

fix(test-tooling): use of hardcoded password #3428

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ashnashahgrover
Copy link
Contributor

@ashnashahgrover ashnashahgrover commented Jul 22, 2024

Commit to be reviewed


fix(test-tooling): use of hardcoded password

Primary Changes
----------------
1. BREAKING CHANGE: "password" is now a mandatory parameter of the newEthPersonalAccount function
defined in openethereum-test-ledger.ts. It was previously optional.
2. Updated line 236 in openethereum-test-ledger.ts so the default password argument to the
newEthPersonalAccount function is not hardcoded.

Fixes #2766

Pull Request Requirements

  • Rebased onto upstream/main branch and squashed into single commit to help maintainers review it more efficient and to avoid spaghetti git commit graphs that obfuscate which commit did exactly what change, when and, why.
  • Have git sign off at the end of commit message to avoid being marked red. You can add -s flag when using git commit command. You may refer to this link for more information.
  • Follow the Commit Linting specification. You may refer to this link for more information.

Character Limit

  • Pull Request Title and Commit Subject must not exceed 72 characters (including spaces and special characters).
  • Commit Message per line must not exceed 80 characters (including spaces and special characters).

A Must Read for Beginners
For rebasing and squashing, here's a must read guide for beginners.

Copy link
Contributor

@jagpreetsinghsasan jagpreetsinghsasan left a comment

Choose a reason for hiding this comment

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

Did you verify if the test cases requiring this piece of code clearly specifies test as the password?

@ashnashahgrover
Copy link
Contributor Author

Did you verify if the test cases requiring this piece of code clearly specifies test as the password?

@jagpreetsinghsasan There are no test cases in the repo using this code/function

Copy link
Member

@petermetz petermetz left a comment

Choose a reason for hiding this comment

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

@ashnashahgrover Please fix the commit lint issues and document that it's a breaking change in the commit message (which then will get recognized by the change log and put in the release notes).
You can find the expected format for breaking changes in the conventional commit messages standard.

@ashnashahgrover ashnashahgrover force-pushed the ashnashahgrover/issue2766 branch 2 times, most recently from 67e9390 to 8bdc830 Compare August 5, 2024 03:36
@ashnashahgrover
Copy link
Contributor Author

ashnashahgrover commented Aug 5, 2024

@ashnashahgrover Please fix the commit lint issues and document that it's a breaking change in the commit message (which then will get recognized by the change log and put in the release notes). You can find the expected format for breaking changes in the conventional commit messages standard.

@petermetz I have addressed these requests.

Copy link
Member

@petermetz petermetz left a comment

Choose a reason for hiding this comment

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

@ashnashahgrover The breaking change is that you made a previously optional parameter of the function mandatory. It doesn't refer to line breaks in text (although those can be important too because the commit linter will fail that as well).
Please refactor the PR description/commit message accordingly.

@ashnashahgrover
Copy link
Contributor Author

@ashnashahgrover The breaking change is that you made a previously optional parameter of the function mandatory. It doesn't refer to line breaks in text (although those can be important too because the commit linter will fail that as well). Please refactor the PR description/commit message accordingly.

Have adjusted both the commit message and PR description accordingly.

@jagpreetsinghsasan
Copy link
Contributor

@ashnashahgrover The breaking change is that you made a previously optional parameter of the function mandatory. It doesn't refer to line breaks in text (although those can be important too because the commit linter will fail that as well). Please refactor the PR description/commit message accordingly.

Have adjusted both the commit message and PR description accordingly.

No it isn't updated @ashnashahgrover

CURRENT PR BODY (Breaking changes going out of the primary changes section)
image

CURRENT COMMIT MESSAGE (Breaking changes are after the fixes tag)
image

Copy link
Member

@petermetz petermetz left a comment

Choose a reason for hiding this comment

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

@ashnashahgrover I would recommend just copy pasting the commit message to the PR description so that it's a definite match character by character and see if that fixes the PR commit parity check. You can better see the differences if you open them up next to each other on two separate browser windows like this:

image

Primary Changes
----------------
1. BREAKING CHANGE: "password" is now a mandatory parameter of the newEthPersonalAccount function
defined in openethereum-test-ledger.ts. It was previously optional.
2. Updated line 236 in openethereum-test-ledger.ts so the default password argument to the
newEthPersonalAccount function is not hardcoded.

Fixes hyperledger#2766

Signed-off-by: ashnashahgrover <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

fix(test-tooling): use of hardcoded password
4 participants