Skip to content
This repository has been archived by the owner on Aug 18, 2020. It is now read-only.

[CO-354] Fix ProtocolMagic Eq instance & related tests #3618

Merged

Conversation

mhuesch
Copy link
Contributor

@mhuesch mhuesch commented Sep 18, 2018

Description

We had written a custom Eq instances, in order to be safe, so any
equality functionality defined over ProtocolMagic would be unchanged.
However this resulted in an issue where our golden tests did not check
the requiresNetworkMagic field, thus rendering them ineffective.

I switch to a derived Eq instance, and modify the golden tests to use
the correct default value.

Linked issue

https://iohk.myjetbrains.com/youtrack/issue/CO-354

Type of change

  • 🐞 Bug fix (non-breaking change which fixes an issue)
  • [~] 🛠 New feature (non-breaking change which adds functionality)
  • [~] ⚠️ Breaking change (fix or feature that would cause existing functionality to change)
  • [~] 🏭 Refactoring that does not change existing functionality but does improve things like code readability, structure etc
  • [~] 🔨 New or improved tests for existing code
  • [~] ⛑ git-flow chore (backport, hotfix, etc)

Developer checklist

  • I have read the style guide document, and my code follows the code style of this project.
  • If my code deals with exceptions, it follows the guidelines.
  • I have updated any documentation accordingly, if needed. Documentation changes can be reflected in opening a PR on cardanodocs.com, amending the inline Haddock comments, any relevant README file or one of the document listed in the docs directory.
  • [~] CHANGELOG entry has been added and is linked to the correct PR on GitHub.

Testing checklist

  • I have added tests to cover my changes.
  • All new and existing tests passed.

We had written a custom Eq instances, in order to be safe, so any
equality functionality defined over `ProtocolMagic` would be unchanged.
However this resulted in an issue where our golden tests did not check
the `requiresNetworkMagic` field, thus rendering them ineffective.

I switch to a derived Eq instance, and modify the golden tests to use
the correct default value.
@@ -81,19 +80,13 @@ newtype ProtocolMagicId = ProtocolMagicId
data ProtocolMagic = ProtocolMagic
{ getProtocolMagicId :: !ProtocolMagicId
, getRequiresNetworkMagic :: !RequiresNetworkMagic
} deriving (Show, Generic)
} deriving (Eq, Show, Generic)
Copy link
Contributor

Choose a reason for hiding this comment

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

👍

Copy link
Member

@erikd erikd left a comment

Choose a reason for hiding this comment

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

Good catch!

@adinapoli-iohk adinapoli-iohk merged commit 1b39e25 into release/1.3.1 Sep 18, 2018
@intricate intricate deleted the intricate+mhuesch/CO-354/fix-protocolmagic-eq branch September 18, 2018 13:46
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants