Merge pull request #29 from platformsh/DEVREL-459

is_enterprise/is_dedicated for Python

Author: Nick Anderegg

CHANGELOG.md

@@ -1,13 +1,65 @@
-# Version History
+# Changelog
 
-## Unreleased
+## [2.3.1] - 2019-11-04
 
-* **Improvements**
+### Added
 
-* **Fixes**
+* `CHANGELOG` added.
+* `on_dedicated` method that determines if the current environment is a Platform.sh Dedicated environment. Replaces deprecated `on_enterprise` method.
 
-* **Misc.**
+### Changed
 
-## v0.1.0 (2010-02-14)
+* Deprecates `on_enterprise` method - which is for now made to wrap around the added `on_dedicated` method. `on_enterprise` **will be removed** in a future release, so update your projects to use `on_dedicated` instead as soon as possible.
 
-- Initial version.
+## [2.3.0] - 2019-09-19
+
+### Added
+
+* `get_primary_route` method for accessing routes marked "primary" in `routes.yaml`.
+* `get_upstream_routes` method returns an object map that includes only those routes that point to a valid upstream.
+
+## [2.2.3] - 2019-04-30
+
+### Changed
+
+* Removes guard on `variables()` method.
+
+## [2.2.2] - 2019-04-29
+
+### Changed
+
+* Refactors dynamic property access to be more permissive.
+
+## [2.2.1] - 2019-04-25
+
+### Changed
+
+* More permissive check for relationships.
+
+## [2.2.0] - 2019-04-24
+
+### Added
+
+* `postgresql_dsn` credential formatter; returns a DSN appropriate for PostgreSQL connection.
+
+## [2.1.1] - 2019-03-22
+
+### Changed
+
+* Fixes build issues in `has_relationship()` and `routes()` methods.
+
+## [2.1.0] - 2019-03-22
+
+### Added
+
+* `has_relationship` method to determine if a relationship is defined, and thus has credentials available.
+
+### Changed
+
+* Fixes `routes` method.
+
+## [2.0.4] - 2019-03-06
+
+### Added
+
+* CircleCI configuration

README.md

@@ -60,11 +60,17 @@ config.in_build()
 
 config.in_runtime()
 
-config.on_enterprise()
+config.on_dedicated()
 
 config.on_production()
 ```
 
+> **Note:**
+>
+> Platform.sh will no longer refer to its [99.99% uptime SLA product](https://platform.sh/solutions/) as "Enterprise", but rather as "Dedicated". Configuration Reader libraries have in turn been updated to include an `on_dedicated` method to replace `on_enterprise`. For now `on_enterprise` remains available. It now calls the new method and no breaking changes have been introduced.
+>
+> It is recommended that you update your projects to use `on_dedicated` as soon as possible, as `on_enterprise` will be removed in a future version of this library.
+
 ### Read environment variables
 
 The following magic properties return the corresponding environment variable value.  See the [Platform.sh documentation](https://docs.platform.sh/development/variables.html) for a description of each.

platformshconfig/config.py

@@ -376,17 +376,32 @@ def application(self):
             )
         return self._applicationDef
 
-    def on_enterprise(self):
-        """Determines if the current environment is a Platform.sh Enterprise environment.
+    def on_dedicated(self):
+        """Determines if the current environment is a Platform.sh Dedicated environment.
 
         Returns:
             bool:
-                True on an Enterprise environment, False otherwise.
+                True on an Dedicated environment, False otherwise.
 
         """
 
         return self.is_valid_platform() and self['MODE'] == 'enterprise'
 
+    def on_enterprise(self):
+        """Determines if the current environment is a Platform.sh Dedicated environment.
+
+        @deprecated
+
+        The Platform.sh "Enterprise" will soon be referred to exclusively as "Dedicated". the `on_enterprise` method remains available for now, but it will be removed in a future version of this library.
+        It is recommended that you update your projects to use `on_dedicated` as soon as possible.
+
+        Returns:
+            bool:
+                True on a Dedicated environment, False otherwise.
+        """
+
+        return self.on_dedicated()
+
     def on_production(self):
         """Determines if the current environment is a production environment.
 
@@ -403,7 +418,7 @@ def on_production(self):
 
         if not self.is_valid_platform() and not self.in_build():
             return False
-        prod_branch = 'production' if self.on_enterprise() else 'master'
+        prod_branch = 'production' if self.on_dedicated() else 'master'
         return self['BRANCH'] == prod_branch
 
     def register_formatter(self, name, formatter):

setup.py

@@ -12,7 +12,7 @@
 
 cwd = os.path.abspath(os.path.dirname(__file__))
 
-VERSION = "2.3.0"
+VERSION = "2.3.1"
 
 with open('README.md', 'r', encoding='utf-8') as f:
     __readme__ = f.read()

tests/test_config.py

@@ -155,24 +155,26 @@ def test_upstream_routes_for_app_on_dedicated(self):
         self.assertTrue("https://www.master-7rqtwti-gcpjkefjk4wc2.us-2.platformsh.site/" in routes)
         self.assertEqual("https://www.{default}/", routes["https://www.master-7rqtwti-gcpjkefjk4wc2.us-2.platformsh.site/"]["original_url"])
 
-    def test_onenterprise_returns_true_on_enterprise(self):
+    def test_ondedicated_returns_true_on_dedicated(self):
 
         env = self.mockEnvironmentDeploy
         env['PLATFORM_MODE'] = 'enterprise'
 
         config = Config(env)
 
         self.assertTrue(config.on_enterprise())
+        self.assertTrue(config.on_dedicated())
 
-    def test_onenterprise_returns_false_on_standard(self):
+    def test_ondedicated_returns_false_on_standard(self):
 
         env = self.mockEnvironmentDeploy
 
         config = Config(env)
 
         self.assertFalse(config.on_enterprise())
+        self.assertFalse(config.on_dedicated())
 
-    def test_onproduction_on_enterprise_prod_is_true(self):
+    def test_onproduction_on_dedicated_prod_is_true(self):
 
         env = self.mockEnvironmentDeploy
         env['PLATFORM_MODE'] = 'enterprise'
@@ -182,7 +184,7 @@ def test_onproduction_on_enterprise_prod_is_true(self):
 
         self.assertTrue(config.on_production())
 
-    def test_onproduction_on_enterprise_stg_is_false(self):
+    def test_onproduction_on_dedicated_stg_is_false(self):
 
         env = self.mockEnvironmentDeploy
         env['PLATFORM_MODE'] = 'enterprise'