make account optional. auto configure when not defined (#3)

Author: Leemoonsoo

README.md

@@ -10,20 +10,34 @@ pip install staroid
 ## Quickstart
 
 
-Initialize
-
 ```python
 from staroid import Staroid
 
-# with no argument, it searches configuration ~/.staroid/config first and then try in-cluster configuration
-strd = Staroid()
+star = Staroid()
+
+# create a ske kubernetes cluster
+my_cluster = star.cluster().create("my cluster", "gcp us-west1")
 
-# alternatively, pass access token through the argument
-strd = Staroid(access_token="<access token>", org="<org_name>")
+# create a namespace and deploy project 
+ns = star.namespace(my_cluster).create("my_app", "GITHUB/staroids/namespace:master")
 ```
 
-Select cluster
+## Configuration
 
-```python
-cluster1 = strd.cluster("<cluster_name>")
-```
+### Environment variables
+
+| Env variable | optional | description |
+| ------------- | ---------- | ------------ |
+| STAROID_ACCESS_TOKEN | false | Access token generated from [here](https://staroid.com/settings/accesstokens) |
+| STAROID_ACCOUNT | true | Account to use. e.g. `GITHUB/my_github_login` |
+
+### Config file
+
+Altanatively, you can create `~/.staroid/config.yaml` file like below.
+
+```yaml
+access_token: <your access token> # access token from https://staroid.com/settings/accesstokens
+account: <account> # optional. e.g. "GITHUB/my_github_login"
+```
+
+When both config file and environment variables exist, environment variable will take precedence.

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="staroid", # Replace with your own username
-    version="0.0.2",
+    version="0.0.3",
     license='MIT',
     author="Staroid",
     author_email="support@staroid.com",

staroid/cluster.py

@@ -57,7 +57,7 @@ def get(self, name):
         return cluster_found
 
     def get_all(self):
-        r = self.__staroid._api_get("orgs/{}/vc".format(self.__staroid.get_org()))
+        r = self.__staroid._api_get("orgs/{}/vc".format(self.__staroid.get_account()))
         if r.status_code == 200:
             json_object_list = json.loads(r.text)
             cluster_list = []
@@ -71,7 +71,7 @@ def get_all(self):
 
     def create(self, name, cluster="gcp us-west1"):
         r = self.__staroid._api_post(
-            "orgs/{}/vc".format(self.__staroid.get_org()),
+            "orgs/{}/vc".format(self.__staroid.get_account()),
             {
                 "name": name,
                 "clusterId": CLUSTER_ID_MAP[cluster]
@@ -92,7 +92,7 @@ def delete(self, name):
         cluster_to_del = self.get(name)
         if cluster_to_del != None:
             r = self.__staroid._api_delete(
-                "orgs/{}/vc/{}".format(self.__staroid.get_org(), cluster_to_del.id())
+                "orgs/{}/vc/{}".format(self.__staroid.get_account(), cluster_to_del.id())
             )
         else:
             return None

staroid/namespace.py

@@ -41,7 +41,7 @@ def __init__(self, staroid, cluster):
     def get_all(self):
         r = self.__staroid._api_get(
             "orgs/{}/vc/{}/instance".format(
-                self.__staroid.get_org(),
+                self.__staroid.get_account(),
                 self.__cluster.id()
             )
         )
@@ -69,7 +69,7 @@ def get(self, instance_name):
     def get_by_id(self, instance_id):
         r = self.__staroid._api_get(
             "orgs/{}/vc/{}/instance/{}".format(
-                self.__staroid.get_org(),
+                self.__staroid.get_account(),
                 self.__cluster.id(),
                 instance_id
             )
@@ -86,7 +86,7 @@ def create(self, instance_name, commit_url):
 
         r = self.__staroid._api_post(
             "orgs/{}/vc/{}/instance".format(
-                self.__staroid.get_org(),
+                self.__staroid.get_account(),
                 self.__cluster.id()
             ),
             {
@@ -114,7 +114,7 @@ def delete(self, instance_name):
 
         r = self.__staroid._api_delete(
             "orgs/{}/vc/{}/instance/{}".format(
-                self.__staroid.get_org(),
+                self.__staroid.get_account(),
                 self.__cluster.id(),
                 ns.id()
             )
@@ -136,7 +136,7 @@ def start(self, instance_name):
 
         r = self.__staroid._api_put(
             "orgs/{}/vc/{}/instance/{}/resume".format(
-                self.__staroid.get_org(),
+                self.__staroid.get_account(),
                 self.__cluster.id(),
                 ns.id()
             )
@@ -158,7 +158,7 @@ def stop(self, instance_name):
 
         r = self.__staroid._api_put(
             "orgs/{}/vc/{}/instance/{}/pause".format(
-                self.__staroid.get_org(),
+                self.__staroid.get_account(),
                 self.__cluster.id(),
                 ns.id()
             )
@@ -180,7 +180,7 @@ def shell_start(self, instance_name):
 
         r = self.__staroid._api_post(
             "orgs/{}/vc/{}/instance/{}/shell".format(
-                self.__staroid.get_org(),
+                self.__staroid.get_account(),
                 self.__cluster.id(),
                 ns.id()
             )
@@ -201,7 +201,7 @@ def shell_stop(self, instance_name):
 
         r = self.__staroid._api_delete(
             "orgs/{}/vc/{}/instance/{}/shell".format(
-                self.__staroid.get_org(),
+                self.__staroid.get_account(),
                 self.__cluster.id(),
                 ns.id()
             )

staroid/staroid.py

@@ -19,26 +19,58 @@ def provider(self):
     def id(self):
         return int(self.__json["id"])
 
+class User:
+    def __init__(self, json):
+        self.__json = json
+
+    def name(self):
+        return self.__json["name"]
+
+    def provider(self):
+        return self.__json["provider"]
+
+    def principal(self):
+        return self.__json["principal"]
+
+
 class Staroid:
     """Staroid client object"""
 
-    def __init__(self, access_token=None, org=None, config_path="~/.staroid/config.yaml"):
+    def __init__(self, access_token=None, account=None, config_path="~/.staroid/config.yaml"):
         self.__api_addr = "https://staroid.com/api"
+        self.__access_token = None
+        self.__account = None
+
+        # 1. set from configs
         self.__read_config(config_path)
 
+        # 2. set from env
+        if "STAROID_ACCESS_TOKEN" in os.environ:
+            self.__access_token = os.environ["STAROID_ACCESS_TOKEN"]
+
+        if "STAROID_ACCOUNT" in os.environ:
+            self.__account = os.environ["STAROID_ACCOUNT"]
+
+        # 3. set from args
         if access_token != None:
             self.__access_token = access_token
 
-        if org != None:
-            self.__org = org
+        if account != None:
+            self.__account = account
+
+        # if account is not set, set default user account
+        if self.__account == None:
+            user = self.get_user()
+            if user != None:
+                self.__account = "{}/{}".format(user.provider(), user.principal())
 
     def __read_config(self, config_path):
         try:
             with open(config_path, "r") as f:
                 logging.info("Read configuration from " + config_path)
                 data = yaml.load(f, Loader=yaml.FullLoader)
                 self.__access_token = data.get("access_token", None)
-                self.__org = data.get("default_org", None)
+                self.__account = data.get("account", None)
         except EnvironmentError:
             pass
 
@@ -53,14 +85,26 @@ def namespace(self, cluster):
     def get_access_token(self):
         return self.__access_token
 
-    def get_org(self):
-        return self.__org
+    def get_account(self):
+        return self.__account
 
-    def with_org(self, org):
-        self.__org = org
+    def with_account(self, account):
+        self.__account = account
         return self
 
-    def get_all_orgs(self):
+    def get_user(self):
+        "read user information"
+        if self.__access_token == None:
+            return None
+
+        r = self._api_get("auth/user")
+        if r.status_code == 200:
+            js = json.loads(r.text)
+            return User(js)
+        else:
+            return None
+
+    def get_all_accounts(self):
         r = self._api_get("orgs/")
         if r.status_code == 200:
             org_object_list = json.loads(r.text)
@@ -70,7 +114,7 @@ def get_all_orgs(self):
 
             return org_list
         else:
-            logging.error("Can't get orgs")
+            logging.error("Can't get accounts")
             return None
 
     def __get_request_url(self, path):

tests/test_cluster.py

@@ -10,14 +10,14 @@ def integration_test_ready():
 class TestCluster(unittest.TestCase):
     @unittest.skipUnless(integration_test_ready(), "Integration test environment is not configured")
     def test_initialize(self):
-        s = Staroid(access_token=os.environ["STAROID_ACCESS_TOKEN"], org=os.environ["STAROID_ACCOUNT"])
-        all_orgs = s.get_all_orgs()
+        s = Staroid(access_token=os.environ["STAROID_ACCESS_TOKEN"], account=os.environ["STAROID_ACCOUNT"])
+        s.get_all_accounts()
 
     @unittest.skipUnless(integration_test_ready(), "Integration test environment is not configured")
     def test_crud(self):
         # given
-        s = Staroid(access_token=os.environ["STAROID_ACCESS_TOKEN"], org=os.environ["STAROID_ACCOUNT"])
-        all_orgs = s.get_all_orgs()
+        s = Staroid(access_token=os.environ["STAROID_ACCESS_TOKEN"], account=os.environ["STAROID_ACCOUNT"])
+        all_accounts = s.get_all_accounts()
         clusters_before = s.cluster().get_all()
 
         # when create

tests/test_namespace.py

@@ -20,8 +20,7 @@ class TestCluster(unittest.TestCase):
     @unittest.skipUnless(integration_test_ready(), "Integration test environment is not configured")
     def test_crud_namespace(self):
         # given
-        s = Staroid(access_token=os.environ["STAROID_ACCESS_TOKEN"], org=os.environ["STAROID_ACCOUNT"])
-        all_orgs = s.get_all_orgs()
+        s = Staroid(access_token=os.environ["STAROID_ACCESS_TOKEN"], account=os.environ["STAROID_ACCOUNT"])
         c = s.cluster().create("staroid-python it-test-namespace")
 
         # when create a namespace

tests/test_staroid.py

@@ -1,21 +1,59 @@
 import unittest
 import tempfile
+import os
 
 from staroid import Staroid
 
+def integration_test_ready():
+    return "STAROID_ACCESS_TOKEN" in os.environ and "STAROID_ACCOUNT" in os.environ
+
 class TestStaroid(unittest.TestCase):
     def test_initialize(self):
         s = Staroid()
 
     def test_read_config(self):
+        # unset env
+        at = None
+        ac = None
+        if "STAROID_ACCESS_TOKEN" in os.environ:
+            at = os.environ["STAROID_ACCESS_TOKEN"]  
+            del os.environ["STAROID_ACCESS_TOKEN"]  
+        if "STAROID_ACCOUNT" in os.environ:
+            ac = os.environ["STAROID_ACCOUNT"]
+            del os.environ["STAROID_ACCOUNT"]
+
         # given
         fp = tempfile.NamedTemporaryFile()
-        fp.write(b"access_token: abc\ndefault_org: GITHUB/user1")
+        fp.write(b"access_token: abc\naccount: GITHUB/user1")
         fp.flush()
 
         # when
         s = Staroid(config_path=fp.name)
 
         # then
         self.assertEqual("abc", s.get_access_token())
-        self.assertEqual("GITHUB/user1", s.get_org())
+        self.assertEqual("GITHUB/user1", s.get_account())
+
+        # restore env
+        if at != None:
+            os.environ["STAROID_ACCESS_TOKEN"] = at
+        if ac != None:
+            os.environ["STAROID_ACCOUNT"] = ac
+
+    @unittest.skipUnless(integration_test_ready(), "Integration test environment is not configured")
+    def test_read_default_account(self):
+        # given access_token is set but account is not set
+        ac = None
+        if "STAROID_ACCOUNT" in os.environ:
+            ac = os.environ["STAROID_ACCOUNT"]
+            del os.environ["STAROID_ACCOUNT"]
+
+        # when
+        s = Staroid()
+
+        # then
+        self.assertNotEqual(None, s.get_account())
+
+        # restore env
+        if ac != None:
+            os.environ["STAROID_ACCOUNT"] = ac