Merge pull request #1 from j12y/feature/manifest-services

rename env vars, app manifest create/get for services

Author: j12y

predix/admin/acs.py

@@ -29,8 +29,8 @@ def create(self):
         starting settings.
         """
         self.service.create()
-        os.environ['PREDIX_ACS_URI'] = self.service.settings.data['uri']
-        os.environ['PREDIX_ACS_ZONE_ID'] = self.service.serttings.data['zone']['http-header-value']
+        os.environ[self.__module__ + '.uri'] = self.service.settings.data['uri']
+        os.environ[self.__module__ + '.zone_id'] = self.service.settings.data['zone']['http-header-value']
 
     def grant_client(self, client_id):
         """
@@ -63,9 +63,9 @@ def add_to_manifest(self, manifest_path):
         manifest.add_service(self.service.name)
 
         # Add environment variables
-        manifest.add_env_var('PREDIX_ACS_URI',
+        manifest.add_env_var(self.__module__ + '.uri',
                 self.service.settings.data['uri'])
-        manifest.add_env_var('PREDIX_ACS_ZONE_ID',
+        manifest.add_env_var(self.__module__ + '.zone_id',
                 self.service.settings.data['zone']['http-header-value'])
 
         manifest.write_manifest()

predix/admin/asset.py

@@ -29,8 +29,8 @@ def create(self):
         starting settings.
         """
         self.service.create()
-        os.environ['PREDIX_ASSET_URI'] = self.service.settings.data['uri']
-        os.environ['PREDIX_ASSET_ZONE_ID'] = self.get_zone_id()
+        os.environ[self.__module__ + '.uri'] = self.service.settings.data['uri']
+        os.environ[self.__module__ + '.zone_id'] = self.get_zone_id()
 
     def grant_client(self, client_id):
         """
@@ -65,8 +65,8 @@ def add_to_manifest(self, manifest_path):
         manifest.add_service(self.service.name)
 
         # Add environment variables
-        manifest.add_env_var('PREDIX_ASSET_URI',
+        manifest.add_env_var(self.__module__ + '.uri',
                 self.service.settings.data['uri'])
-        manifest.add_env_var('PREDIX_ASSET_ZONE_ID', self.get_zone_id())
+        manifest.add_env_var(self.__module__ + '.zone_id', self.get_zone_id())
 
         manifest.write_manifest()

predix/admin/service.py

@@ -55,8 +55,7 @@ def _delete_service(self, service_only=False):
         Delete a Cloud Foundry service and any associations.
         """
         logging.debug('_delete_service()')
-        # delete this ser
-        pass
+        return self.service.delete_service(self.service_name)
 
     def _get_or_create_service_key(self):
         """

predix/admin/timeseries.py

@@ -32,17 +32,17 @@ def create(self):
         self.service.create()
 
         uri = self.service.settings.data['ingest']['uri']
-        os.environ['PREDIX_TIMESERIES_INGEST_URI'] = uri
+        os.environ[self.__module__ + '.ingest.uri'] = uri
 
         zone = self.get_ingest_zone_id()
-        os.environ['PREDIX_TIMESERIES_INGEST_ZONE_ID'] = zone
+        os.environ[self.__module__ + '.ingest.zone_id'] = zone
 
         uri = self.service.settings.data['query']['uri']
         uri = urlparse.urlparse(uri)
-        os.environ['PREDIX_TIMESERIES_QUERY_URI'] = uri.scheme + '://' + uri.netloc
+        os.environ[self.__module__ + '.query.uri'] = uri.scheme + '://' + uri.netloc
 
         zone = self.get_query_zone_id()
-        os.environ['PREDIX_TIMESERIES_QUERY_ZONE_ID'] = zone
+        os.environ[self.__module__ + '.query.zone_id'] = zone
 
     def grant_client(self, client_id, read=True, write=True):
         """
@@ -92,17 +92,17 @@ def add_to_manifest(self, manifest_path):
         manifest.add_service(self.service.name)
 
         # Add environment variables
-        manifest.add_env_var('PREDIX_TIMESERIES_INGEST_URI',
+        manifest.add_env_var(self.__module__ + '.ingest.uri',
                 self.service.settings.data['ingest']['uri'])
-        manifest.add_env_var('PREDIX_TIMESERIES_INGEST_ZONE_ID',
+        manifest.add_env_var(self.__module__ + '.ingest.zone_id',
                 self.get_ingest_zone_id())
 
         # Query URI has extra path we don't want
         uri = self.service.settings.data['query']['uri']
         uri = urlparse.urlparse(uri)
-        manifest.add_env_var('PREDIX_TIMESERIES_QUERY_URI',
+        manifest.add_env_var(self.__module__ + '.query.uri',
                 uri.scheme + '://' + uri.netloc)
-        manifest.add_env_var('PREDIX_TIMESERIES_QUERY_ZONE_ID',
+        manifest.add_env_var(self.__module__ + '.query.zone_id',
                 self.get_query_zone_id())
 
         manifest.write_manifest()

predix/admin/uaa.py

@@ -43,6 +43,9 @@ def create(self, secret):
         parameters = {"adminClientSecret": secret}
         self.service.create(parameters=parameters)
 
+        uri = self.service.settings.data['uri']
+        os.environ[self.__module__ + '.uri'] = uri
+
         # Once we create it login
         self.authenticate()
 
@@ -57,7 +60,7 @@ def add_to_manifest(self, manifest_path):
         manifest.add_service(self.service.name)
 
         # Add environment variables
-        manifest.add_env_var('PREDIX_UAA_URI',
+        manifest.add_env_var(self.__module__ + '.uri',
                 self.service.settings.data['uri'])
 
         manifest.write_manifest()
@@ -66,7 +69,7 @@ def authenticate(self):
         """
         Authenticate into the UAA instance as the admin user.
         """
-        os.environ['PREDIX_UAA_URI'] = self.service.settings.data['uri']
+        os.environ[self.__module__ + '.uri'] = self.service.settings.data['uri']
         self.uaac = predix.security.uaa.UserAccountAuthentication()
         self.uaac.authenticate('admin', self._get_admin_secret(),
                 use_cache=False)

predix/admin/weather.py

@@ -27,9 +27,9 @@ def create(self):
         self.service.create()
 
         zone = self.service.settings.data['zone']['http-header-value']
-        os.environ['PREDIX_WEATHER_ZONE_ID'] = zone
+        os.environ[self.__module__ + '.zone_id'] = zone
         uri = self.service.settings.data['uri']
-        os.environ['PREDIX_WEATHER_URI'] = uri
+        os.environ[self.__module__ + '.uri'] = uri
 
     def add_to_manifest(self, manifest_path):
         manifest = predix.app.Manifest(manifest_path)
@@ -38,9 +38,9 @@ def add_to_manifest(self, manifest_path):
         manifest.add_service(self.service.name)
 
         # Add environment variables
-        manifest.add_env_var('PREDIX_WEATHER_ZONE_ID',
+        manifest.add_env_var(self.__module__ + '.zone_id',
                 self.service.settings.data['zone']['http-header-value'])
-        manifest.add_env_var('PREDIX_WEATHER_URI',
+        manifest.add_env_var(self.__module__ + '.uri',
                 self.service.settings.data['uri'])
 
         manifest.write_manifest()

predix/app.py

@@ -14,6 +14,10 @@ def __init__(self, manifest_path, app_name='my-predix-app'):
         self.manifest_path = os.path.expanduser(manifest_path)
         self.app_name = app_name
 
+        # App may have a client
+        self.client_id = None
+        self.client_secret = None
+
         # Read or Generate a manifest file
         if os.path.exists(self.manifest_path):
             manifest = self.read_manifest()
@@ -89,17 +93,144 @@ def get_client_id(self):
         needed scopes and authorities for the services
         in this manifest.
         """
-        if 'PREDIX_APP_CLIENT_ID' not in self.manifest['env']:
-            raise ValueError('UAA client id must be added to manifest.')
+        key = 'predix.security.uaa.client_id'
+        if key not in self.manifest['env']:
+            raise ValueError("%s undefined in manifest." % key)
 
-        return self.manifest['env']['PREDIX_APP_CLIENT_ID']
+        self.client_id = self.manifest['env'][key]
+        return self.client_id
 
     def get_client_secret(self):
         """
         Return the client secret that should correspond with
         the client id.
         """
-        if 'PREDIX_APP_CLIENT_SECRET' not in self.manifest['env']:
-            raise ValueError('UAA client secret must be added to manifest.')
+        key = 'predix.security.uaa.client_secret'
+        if key not in self.manifest['env']:
+            raise ValueError("%s must be added to manifest." % key)
+
+        self.client_secret = self.manifest['env'][key]
+        return self.client_secret
+
+    def create_timeseries(self):
+        """
+        Creates an instance of the Time Series Service.
+        """
+        import predix.admin.timeseries
+        ts = predix.admin.timeseries.TimeSeries()
+        ts.create()
+
+        client_id = self.get_client_id()
+        if client_id:
+            ts.grant_client(client_id)
+
+        ts.add_to_manifest(self.manifest_path)
+        return ts
+
+    def get_timeseries(self, *args, **kwargs):
+        """
+        Returns an instance of the Time Series Service.
+        """
+        import predix.data.timeseries
+        ts = predix.data.timeseries.TimeSeries(*args, **kwargs)
+        return ts
+
+    def create_asset(self):
+        """
+        Creates an instance of the Asset Service.
+        """
+        import predix.admin.asset
+        asset = predix.admin.asset.Asset()
+        asset.create()
+
+        client_id = self.get_client_id()
+        if client_id:
+            asset.grant_client(client_id)
+
+        asset.add_to_manifest(self.manifest_path)
+        return asset
+
+    def get_asset(self):
+        """
+        Returns an instance of the Asset Service.
+        """
+        import predix.data.asset
+        asset = predix.data.asset.Asset()
+        return asset
+
+    def create_uaa(self, admin_secret):
+        """
+        Creates an instance of UAA Service.
+        """
+        import predix.admin.uaa
+        uaa = predix.admin.uaa.UserAccountAuthentication()
+        if not uaa.exists():
+            uaa.create(admin_secret)
+            uaa.add_to_manifest(self.manifest_path)
+        return uaa
 
-        return self.manifest['env']['PREDIX_APP_CLIENT_SECRET']
+    def create_client(self, client_id, client_secret):
+        """
+        Create a client and add it to the manifest.
+        """
+        import predix.admin.uaa
+        uaa = predix.admin.uaa.UserAccountAuthentication()
+        uaa.create_client(client_id, client_secret)
+        uaa.add_client_to_manifest(client_id, client_secret,
+                self.manifest_path)
+
+    def get_uaa(self):
+        """
+        Returns an insstance of the UAA Service.
+        """
+        import predix.security.uaa
+        uaa = predix.security.uaa.UserAccountAuthentication()
+        return uaa
+
+    def create_acs(self):
+        """
+        Creates an instance of the Asset Service.
+        """
+        import predix.admin.acs
+        acs = predix.admin.acs.AccessControl()
+        acs.create()
+
+        client_id = self.get_client_id()
+        if client_id:
+            acs.grant_client(client_id)
+
+        acs.grant_client(client_id)
+        acs.add_to_manifest(self.manifest_path)
+        return acs
+
+    def get_acs(self):
+        """
+        Returns an instance of the Asset Control Service.
+        """
+        import predix.security.acs
+        acs = predix.security.acs.AccessControl()
+        return acs
+
+    def create_weather(self):
+        """
+        Creates an instance of the Asset Service.
+        """
+        import predix.admin.weather
+        weather = predix.admin.weather.WeatherForecast()
+        weather.create()
+
+        client_id = self.get_client_id()
+        if client_id:
+            weather.grant_client(client_id)
+
+        weather.grant_client(client_id)
+        weather.add_to_manifest(self.manifest_path)
+        return weather
+
+    def get_weather(self):
+        """
+        Returns an instance of the Weather Service.
+        """
+        import predix.data.weather
+        weather = predix.data.weather.WeatherForecast()
+        return weather

predix/data/asset.py

@@ -16,13 +16,14 @@ class Asset(object):
     def __init__(self, *args, **kwargs):
         super(Asset, self).__init__(*args, **kwargs)
 
-        self.zone_id = os.environ.get('PREDIX_ASSET_ZONE_ID')
+        ns = 'predix.admin.asset'
+        self.zone_id = os.environ.get(ns + '.zone_id')
         if not self.zone_id:
-            raise ValueError('PREDIX_ASSET_ZONE_ID environment unset')
+            raise ValueError("%s.zone_id environment unset" % ns)
 
-        self.uri = os.environ.get('PREDIX_ASSET_URI')
+        self.uri = os.environ.get(ns + '.uri')
         if not self.uri:
-            raise ValueError('PREDIX_ASSET_URI environment unset')
+            raise ValueError("%s.uri environment unset" % ns)
 
         self.service = predix.service.Service(self.zone_id)
 

predix/data/timeseries.py

@@ -23,23 +23,24 @@ class TimeSeries(object):
     def __init__(self, read=True, write=True, *args, **kwargs):
         super(TimeSeries, self).__init__(*args, **kwargs)
 
-        self.query_zone_id = os.environ.get('PREDIX_TIMESERIES_QUERY_ZONE_ID')
-        self.query_uri = os.environ.get('PREDIX_TIMESERIES_QUERY_URI')
+        ns = 'predix.admin.timeseries'
+        self.query_zone_id = os.environ.get(ns + '.query.zone_id')
+        self.query_uri = os.environ.get(ns + '.query.uri')
         if read:
             if not self.query_zone_id:
-                raise ValueError('PREDIX_TIMESERIES_QUERY_ZONE_ID env unset')
+                raise ValueError("%s.query.zone_id env unset" % ns)
 
             if not self.query_uri:
-                raise ValueError('PREDIX_TIMESERIES_QUERY_URI environment unset')
+                raise ValueError("%s.query.uri environment unset" % ns)
 
-        self.ingest_zone_id = os.environ.get('PREDIX_TIMESERIES_INGEST_ZONE_ID')
-        self.ingest_uri = os.environ.get('PREDIX_TIMESERIES_INGEST_URI')
+        self.ingest_zone_id = os.environ.get(ns + '.ingest.zone_id')
+        self.ingest_uri = os.environ.get(ns + '.ingest.uri')
         if write:
             if not self.ingest_zone_id:
-                raise ValueError('PREDIX_TIMESERIES_INGEST_ZONE_ID env unset')
+                raise ValueError("%s.ingest.zone_id env unset" % ns)
 
             if not self.ingest_uri:
-                raise ValueError('PREDIX_TIMESERIES_INGEST_URI environment unset')
+                raise ValueError("%s.ingest.uri environment unset" % ns)
 
         self.service = predix.service.Service(self.query_zone_id)
 

predix/data/weather.py

@@ -9,13 +9,14 @@ class WeatherForecast(object):
     def __init__(self, *args, **kwargs):
         super(WeatherForecast, self).__init__(*args, **kwargs)
 
-        self.uri = os.environ.get('PREDIX_WEATHER_URI')
+        ns = 'predix.admin.weather'
+        self.uri = os.environ.get(ns + '.uri')
         if not self.uri:
-            raise ValueError("PREDIX_WEATHER_URI environment unset")
+            raise ValueError("%s.uri environment unset" % ns)
 
-        self.zone_id = os.environ.get('PREDIX_WEATHER_ZONE_ID')
+        self.zone_id = os.environ.get(ns + '.zone_id')
         if not self.zone_id:
-            raise ValueError("PREDIX_WEATHER_ZONE_ID environment unset")
+            raise ValueError("%s.zone_id environment unset" % ns)
 
         self.service = predix.service.Service(self.zone_id)