Add tests for empty entity ID in experiment traffic allocation (#37)

Author: aliabbasrizvi

CONTRIBUTING.md

@@ -1,7 +1,7 @@
-#Contributing to the Optimizely Python SDK
+# Contributing to the Optimizely Python SDK
 We welcome contributions and feedback! All contributors must sign our [Contributor License Agreement (CLA)](https://docs.google.com/a/optimizely.com/forms/d/e/1FAIpQLSf9cbouWptIpMgukAKZZOIAhafvjFCV8hS00XJLWQnWDFtwtA/viewform) to be eligible to contribute. Please read the [README](README.md) to set up your development environment, then read the guidelines below for information on submitting your code.
 
-##Development process
+## Development process
 
 1. Create a branch off of `devel`: `git checkout -b YOUR_NAME/branch_name`.
 2. Commit your changes. Make sure to add tests!
@@ -11,22 +11,22 @@ We welcome contributions and feedback! All contributors must sign our [Contribut
 6. Open a pull request from `YOUR_NAME/branch_name` to `devel`.
 7. A repository maintainer will review your pull request and, if all goes well, merge it!
 
-##Pull request acceptance criteria
+## Pull request acceptance criteria
 
 * **All code must have test coverage.** We use unittest. Changes in functionality should have accompanying unit tests. Bug fixes should have accompanying regression tests.
   * Tests are located in `/tests` with one file per class.
 * Please don't change the `__version__`. We'll take care of bumping the version when we next release.
 * Lint your code with PEP-8 before submitting.
 
-##Style
+## Style
 We enforce PEP-8 rules with a few minor deviations.
 
-##License
+## License
 
 All contributions are under the CLA mentioned above. For this project, Optimizely uses the Apache 2.0 license, and so asks that by contributing your code, you agree to license your contribution under the terms of the [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0). Your contributions should also include the following header:
 
 ```
-# Copyright 2016, Optimizely
+# Copyright 2017, Optimizely
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
@@ -42,5 +42,5 @@ All contributions are under the CLA mentioned above. For this project, Optimizel
 
 The YEAR above should be the year of the contribution. If work on the file has been done over multiple years, list each year in the section above. Example: Optimizely writes the file and releases it in 2014. No changes are made in 2015. Change made in 2016. YEAR should be “2014, 2016”.
 
-##Contact
+## Contact
 If you have questions, please contact [email protected].

README.md

@@ -1,26 +1,26 @@
-#Optimizely Python SDK
+# Optimizely Python SDK
 [![Build Status](https://travis-ci.org/optimizely/python-sdk.svg?branch=master)](https://travis-ci.org/optimizely/python-sdk)
 [![Coverage Status](https://coveralls.io/repos/github/optimizely/python-sdk/badge.svg)](https://coveralls.io/github/optimizely/python-sdk)
 [![Apache 2.0](https://img.shields.io/github/license/nebula-plugins/gradle-extra-configurations-plugin.svg)](http://www.apache.org/licenses/LICENSE-2.0)
 
 This repository houses the Python SDK for Optimizely Full Stack.
 
-##Getting Started
+## Getting Started
 
-###Installing the SDK
+### Installing the SDK
 
 The SDK is available through [PyPi](https://pypi.python.org/pypi?name=optimizely-sdk&:action=display). To install:
 
 ```
 pip install optimizely-sdk
 ```
 
-###Using the SDK
+### Using the SDK
 See the Optimizely Full Stack [developer documentation](http://developers.optimizely.com/server/reference/index.html) to learn how to set up your first Python project and use the SDK.
 
-##Development
+## Development
 
-###Building the SDK
+### Building the SDK
 
 Build the SDK using the following command:
 
@@ -36,16 +36,16 @@ You can then install the SDK and its dependencies with:
 pip install dist/optimizely-sdk-{VERSION}.tar.gz
 ```
 
-###Unit tests
+### Unit tests
 
-#####Running all tests
+##### Running all tests
 You can run all unit tests with:
 
 ```
 nosetests
 ```
 
-#####Running all tests in a file
+##### Running all tests in a file
 To run all tests under a particular test file you can use the following command:
 
 ```
@@ -58,7 +58,7 @@ For example, to run all tests under `test_event`, the command would be:
 nosetests tests.test_event
 ```
 
-#####Running all tests under a class
+##### Running all tests under a class
 To run all tests under a particular class of tests you can use the following command:
 
 ```
@@ -70,7 +70,7 @@ For example, to run all tests under `test_event.EventTest`, the command would be
 nosetests tests.test_event:EventTest
 ```
 
-#####Running a single test
+##### Running a single test
 To run a single test you can use the following command:
 
 ```
@@ -83,6 +83,6 @@ For example, to run `test_event.EventTest.test_dispatch`, the command would be:
 nosetests tests.test_event:EventTest.test_dispatch
 ```
 
-###Contributing
+### Contributing
 
 Please see [CONTRIBUTING](CONTRIBUTING.md).

tests/base.py

@@ -160,6 +160,9 @@ def setUp(self):
         'trafficAllocation': [{
           'entityId': '111128',
           'endOfRange': 4000
+        }, {
+          'entityId': '',
+          'endOfRange': 5000
         }, {
           'entityId': '111129',
           'endOfRange': 9000

tests/test_bucketing.py

@@ -26,10 +26,10 @@
 from . import base
 
 
-class BucketerTest(base.BaseTestV1):
+class BucketerTest(base.BaseTestV2):
 
   def setUp(self):
-    base.BaseTestV1.setUp(self)
+    base.BaseTestV2.setUp(self)
     self.bucketer = bucketer.Bucketer(self.project_config)
 
   def test_bucket(self):
@@ -44,9 +44,17 @@ def test_bucket(self):
                        ))
     mock_generate_bucket_value.assert_called_once_with('test_user111127')
 
-    # Variation 2
+    # Empty entity ID
     with mock.patch('optimizely.bucketer.Bucketer._generate_bucket_value',
                     return_value=4242) as mock_generate_bucket_value:
+      self.assertIsNone(self.bucketer.bucket(
+        self.project_config.get_experiment_from_key('test_experiment'), 'test_user'
+      ))
+    mock_generate_bucket_value.assert_called_once_with('test_user111127')
+
+    # Variation 2
+    with mock.patch('optimizely.bucketer.Bucketer._generate_bucket_value',
+                    return_value=5042) as mock_generate_bucket_value:
       self.assertEqual(entities.Variation('111129', 'variation'),
                        self.bucketer.bucket(self.project_config.get_experiment_from_key('test_experiment'),
                                             'test_user'))

tests/test_event_builder.py

@@ -352,7 +352,8 @@ def test_create_conversion_event__with_attributes(self):
       'clientEngine': 'python-sdk',
       'clientVersion': version.__version__
     }
-    with mock.patch('time.time', return_value=42.123):
+    with mock.patch('time.time', return_value=42.123), \
+      mock.patch('optimizely.bucketer.Bucketer._generate_bucket_value', return_value=5042):
       event_obj = self.event_builder.create_conversion_event(
         'test_event', 'test_user', {'test_attribute': 'test_value'}, None,
         [self.project_config.get_experiment_from_key('test_experiment')]
@@ -439,7 +440,8 @@ def test_create_conversion_event__with_event_value(self):
       'clientEngine': 'python-sdk',
       'clientVersion': version.__version__
     }
-    with mock.patch('time.time', return_value=42.123):
+    with mock.patch('time.time', return_value=42.123), \
+         mock.patch('optimizely.bucketer.Bucketer._generate_bucket_value', return_value=5042):
       event_obj = self.event_builder.create_conversion_event(
         'test_event', 'test_user', {'test_attribute': 'test_value'}, {'revenue': 4200, 'non-revenue': 'abc'},
         [self.project_config.get_experiment_from_key('test_experiment')]
@@ -496,7 +498,8 @@ def test_create_conversion_event__with_invalid_event_value(self):
       'clientEngine': 'python-sdk',
       'clientVersion': version.__version__
     }
-    with mock.patch('time.time', return_value=42.123):
+    with mock.patch('time.time', return_value=42.123), \
+      mock.patch('optimizely.bucketer.Bucketer._generate_bucket_value', return_value=5042):
       event_obj = self.event_builder.create_conversion_event(
         'test_event', 'test_user', {'test_attribute': 'test_value'}, {'revenue': '4200', 'non-revenue': 'abc'},
         [self.project_config.get_experiment_from_key('test_experiment')]