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

7540: IItemCollectionJsonSerializerTest.java might fail on Windows due to line endings #370

Closed
wants to merge 1 commit into from

Conversation

RealCLanger
Copy link
Collaborator

@RealCLanger RealCLanger commented Jan 21, 2022

Fix test IItemCollectionJsonSerializerTest.java

The line endings should be normalized, to avoid errors on Windows due to incompatible line ending formats.


Progress

  • Commit message must refer to an issue
  • Change must be properly reviewed

Issue

  • JMC-7540: IItemCollectionJsonSerializerTest.java might fail on Windows due to line endings

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/jmc pull/370/head:pull/370
$ git checkout pull/370

Update a local copy of the PR:
$ git checkout pull/370
$ git pull https://git.openjdk.java.net/jmc pull/370/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 370

View PR using the GUI difftool:
$ git pr show -t 370

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/jmc/pull/370.diff

@bridgekeeper
Copy link

bridgekeeper bot commented Jan 21, 2022

👋 Welcome back clanger! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

@openjdk openjdk bot changed the title JMC-7540 7540: IItemCollectionJsonSerializerTest.java might fail on Windows due to line endings Jan 21, 2022
@openjdk openjdk bot added the rfr label Jan 21, 2022
@mlbridge
Copy link

mlbridge bot commented Jan 21, 2022

Webrevs

@openjdk
Copy link

openjdk bot commented Jan 21, 2022

@RealCLanger This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

7540: IItemCollectionJsonSerializerTest.java might fail on Windows due to line endings

Reviewed-by: hirt

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been no new commits pushed to the master branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential automatic rebasing, please check the documentation for the /integrate command for further details.

As you do not have Committer status in this project an existing Committer must agree to sponsor your change. Possible candidates are the reviewers of this PR (@thegreystone) but any other Committer may sponsor as well.

➡️ To flag this PR as ready for integration with the above commit message, type /integrate in a new comment. (Afterwards, your sponsor types /sponsor in a new comment to perform the integration).

@openjdk openjdk bot added the ready label Jan 21, 2022
Fix test IItemCollectionJsonSerializerTest.java
@RealCLanger
Copy link
Collaborator Author

/integrate

@openjdk openjdk bot added the sponsor label Jan 22, 2022
@openjdk
Copy link

openjdk bot commented Jan 22, 2022

@RealCLanger
Your change (at version b4d1e56) is now ready to be sponsored by a Committer.

@thegreystone
Copy link
Member

/sponsor

@openjdk
Copy link

openjdk bot commented Jan 22, 2022

Going to push as commit 3d03643.

@openjdk
Copy link

openjdk bot commented Jan 22, 2022

@thegreystone @RealCLanger Pushed as commit 3d03643.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

@RealCLanger RealCLanger deleted the jmc-7540 branch January 22, 2022 22:00
@@ -66,7 +66,7 @@ public void testSerializeKnownRecording() throws IOException {

String actual = IItemCollectionJsonSerializer.toJsonString(testRecording);

assertEquals(expected, actual);
assertEquals(expected.replaceAll("\\r\\n", "\n"), actual.replaceAll("\\r\\n", "\n"));
Copy link
Contributor

Choose a reason for hiding this comment

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

Sorry, I'm late to the party 🙈 I wrote this test and I'm curious what the problem was here 😃

Did this test fail for you? I don't understand how it can be different on windows since the JSON file has unix line endings and the serialiser will output unix line endings.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Hm, it's been a while but obviously it failed for me. In the bug I've written: On Windows, the returned data from IItemCollectionJsonSerializer.toJsonString(testRecording) seems to have platform line endings. Are you sure that there should be unix line endings?

Copy link
Contributor

Choose a reason for hiding this comment

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

👍 Yup, you're right. Sorry, I didn't check StructuredWriter.java, there we are using String.format("%n"); which will output platform dependent line terminators 😃

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

3 participants