Skip to content
This repository has been archived by the owner on May 12, 2021. It is now read-only.

METRON-1670 Stellar WEEK_OF_YEAR test is locale sensitive #1104

Closed

Conversation

simonellistonball
Copy link
Contributor

Contributor Comments

Tests were previously not local sensitive.

Used a locale sensitive Calendar instance to create ground truth on WeekOfYear test

To test, run the tests of a US Locale and a GB Locale. Both should now pass, previously GB locale failed.

Pull Request Checklist

Thank you for submitting a contribution to Apache Metron.
Please refer to our Development Guidelines for the complete guide to follow for contributions.
Please refer also to our Build Verification Guidelines for complete smoke testing guides.

In order to streamline the review of the contribution we ask you follow these guidelines and ask you to double check the following:

For all changes:

  • Is there a JIRA ticket associated with this PR? If not one needs to be created at Metron Jira.
  • Does your PR title start with METRON-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
  • Has your PR been rebased against the latest commit within the target branch (typically master)?

For code changes:

  • Have you included steps to reproduce the behavior or problem that is being changed or addressed?

  • Have you included steps or a guide to how the change may be verified and tested manually?

  • Have you ensured that the full suite of tests and checks have been executed in the root metron folder via:

    mvn -q clean integration-test install && dev-utilities/build-utils/verify_licenses.sh 
    
  • Have you written or updated unit tests and or integration tests to verify your changes?

  • If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?

  • Have you verified the basic functionality of the build by building and running locally with Vagrant full-dev environment or the equivalent?

For documentation related changes:

  • Have you ensured that format looks appropriate for the output in which it is rendered by building and verifying the site-book? If not then run the following commands and the verify changes via site-book/target/site/index.html:

    cd site-book
    mvn site
    

Note:

Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.
It is also recommended that travis-ci is set up for your personal repository such that your branches are built there before submitting a pull request.

@@ -182,7 +182,8 @@ public void testDayOfMonthNull() {
@Test
public void testWeekOfYear() {
Object result = run("WEEK_OF_YEAR(epoch)");
assertEquals(35, result);
calendar.setTimeInMillis(AUG2016);
Copy link

@rgasiorek rgasiorek Jul 15, 2018

Choose a reason for hiding this comment

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

is it save to morph/mutate an object that is shared (the calendar object which is a property of the test class)? What about a short lived object like that:

@Test
public void testWeekOfYear() {
  Object result = run("WEEK_OF_YEAR(epoch)");
-    assertEquals(35, result);
+    Calendar testCalendar = Calendar.getInstance();
+    testCalendar.setTimeInMillis(AUG2016);
+    assertEquals(testCalendar.get(Calendar.WEEK_OF_YEAR), result);
}

a side note, a more general, having a mutable object to be shared across tests will fire-back but thats bigger problem outside this bug.

btw: since you are in this subcomponent .... I had to add this extra change to remove errors from pom.xml

--- a/metron-stellar/stellar-common/pom.xml
+++ b/metron-stellar/stellar-common/pom.xml
@@ -357,8 +357,10 @@
             <plugin>
                 <artifactId>maven-assembly-plugin</artifactId>
                 <configuration>
-                    <descriptor>src/main/assembly/assembly.xml</descriptor>
-                    <descriptor>src/main/assembly/stand-alone-assembly.xml</descriptor>
+                    <descriptors>
+                        <descriptor>src/main/assembly/assembly.xml</descriptor>
+                        <descriptor>src/main/assembly/stand-alone-assembly.xml</descriptor>
+                    </descriptors>

you could add this change as well.

gn

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It is perfectly safe: The instance is create in the @before annotated method, so in fact, I am already doing exactly what you suggest. See: https://github.com/simonellistonball/metron/blob/bafd3827d273c5c33b4293fd338595b8de3a75b2/metron-stellar/stellar-common/src/test/java/org/apache/metron/stellar/dsl/functions/DateFunctionsTest.java#L61

So there is no sharing of this object between tests, since a new instance is acquired before each test method is run.

The second issue you raise should be handled by a separate unit of change and a separate ticket if it is really necessary (not sure why it would be, but perhaps you could raise a JIRA and explain).

Copy link

@rgasiorek rgasiorek Jul 17, 2018

Choose a reason for hiding this comment

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

sure, makes sense, thanks for your quick response. On the second part: can you elaborate on ' if it 'is really necessary ' - are you suggesting that as it is today is aligned with https://maven.apache.org/plugins/maven-assembly-plugin/usage.html ? Seems like it's not.
IDEs don't like it either as it is today. Not that I am a big IDE user but I learnt to trust them to some extend and I am sure many contributors will use IDEs. That all said - agreed - jira is better place to discuss it further.

@cestella
Copy link
Member

+1 Great catch!

@asfgit asfgit closed this in 4544da7 Jul 16, 2018
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.

3 participants