ALGO-XXX adding better test coverage (#108)

* added new test to ensure we have create, compile, and publish coverage. Minor bugfixes

* added dyanmic environment gathering, added .info() test coverage

Author: zeryx

Algorithmia/algorithm.py

@@ -166,7 +166,7 @@ def versions(self, limit=None, marker=None, published=None, callable=None):
     def compile(self):
         try:
             # Compile algorithm
-            api_response = self.client.manageApi.algorithms_username_algoname_compile_post(self.username, self.algoname)
+            api_response = self.client.manageApi.compile_algorithm(self.username, self.algoname)
             return api_response
         except ApiException as e:
             error_message = json.loads(e.body)

Algorithmia/datafile.py

@@ -250,9 +250,10 @@ def __init__(self, client, dataUrl, cleanup=True):
 
     def __del__(self):
         if self.local_file:
+            filepath = self.local_file.name
             self.local_file.close()
             if self.cleanup:
-                    os.remove(self.local_file)
+                    os.remove(filepath)
 
     def readable(self):
         return True
@@ -267,7 +268,7 @@ def read(self, __size=None):
         if not self.local_file:
             self.local_file = self.getFile()
             output = self.local_file.read()
-        if __size:
+        elif __size:
             output = self.local_file.read(__size)
         else:
             output = self.local_file.read()

Test/client_test.py

@@ -9,63 +9,71 @@
 
 import unittest
 import Algorithmia
+from uuid import uuid4
 
 if sys.version_info.major == 3:
     unicode = str
 
 class ClientTest(unittest.TestCase):
     seed(datetime.now().microsecond)
-
-    username = "a_Mrtest"
-    org_name = "a_myOrg"
+    # due to legacy reasons, regular client tests are tested against api.algorithmia.com, whereas admin api tests are run
+    # against test.algorithmia.com.
+    admin_username = "a_Mrtest"
+    admin_org_name = "a_myOrg"
+    environment_name = "Python 3.9"
 
     def setUp(self):
         self.admin_api_key = unicode(os.environ.get('ALGORITHMIA_A_KEY'))
+        self.regular_api_key = unicode(os.environ.get('ALGORITHMIA_API_KEY'))
+
+        self.admin_username = self.admin_username + str(int(random() * 10000))
+        self.admin_org_name = self.admin_org_name + str(int(random() * 10000))
+        self.admin_client = Algorithmia.client(api_address="https://test.algorithmia.com",
+                                               api_key=self.admin_api_key)
+        self.regular_client = Algorithmia.client(api_address='https://api.algorithmia.com',
+                                    api_key=self.regular_api_key)
 
-        self.username = self.username + str(int(random() * 10000))
-        self.org_name = self.org_name + str(int(random() * 10000))
-        self.c = Algorithmia.client(api_address="https://test.algorithmia.com",
-                                    api_key=self.admin_api_key)
+        environments = self.regular_client.get_environment("python3")
+        for environment in environments['environments']:
+            if environment['display_name'] == self.environment_name:
+                self.environment_id = environment['id']
 
     def test_create_user(self):
-        response = self.c.create_user(
-            {"username": self.username, "email": self.username + "@algo.com", "passwordHash": "",
+        response = self.admin_client.create_user(
+            {"username": self.admin_username, "email": self.admin_username + "@algo.com", "passwordHash": "",
              "shouldCreateHello": False})
 
         if type(response) is dict:
-            self.assertEqual(self.username, response['username'])
+            self.assertEqual(self.admin_username, response['username'])
         else:
             self.assertIsNotNone(response)
 
     def test_get_org_types(self):
-        response = self.c.get_org_types()
+        response = self.admin_client.get_org_types()
         self.assertTrue(len(response) > 0)
 
     def test_create_org(self):
-        response = self.c.create_org(
-            {"org_name": self.org_name, "org_label": "some label", "org_contact_name": "Some owner",
-             "org_email": self.org_name + "@algo.com", "type_id": "basic"})
+        response = self.admin_client.create_org(
+            {"org_name": self.admin_org_name, "org_label": "some label", "org_contact_name": "Some owner",
+             "org_email": self.admin_org_name + "@algo.com", "type_id": "basic"})
 
-        self.assertEqual(self.org_name, response[u'org_name'])
+        self.assertEqual(self.admin_org_name, response[u'org_name'])
 
     def test_get_org(self):
-        response = self.c.get_org("a_myOrg84")
+        response = self.admin_client.get_org("a_myOrg84")
         self.assertEqual("a_myOrg84", response['org_name'])
 
     def test_get_environment(self):
-        client = Algorithmia.client(api_key=unicode(os.environ.get('ALGORITHMIA_API_KEY')))
-        response = client.get_environment("python2")
+        response = self.admin_client.get_environment("python2")
 
         if u'error' not in response:
             self.assertTrue(response is not None and u'environments' in response)
 
     def test_get_build_logs(self):
-        client = Algorithmia.client(api_address='https://api.algorithmia.com',
-                                    api_key=unicode(os.environ.get('ALGORITHMIA_API_KEY')))
         user = unicode(os.environ.get('ALGO_USER_NAME'))
         algo = unicode('echo')
         algo_path = u'%s/%s' % (user, algo)
-        result = client.algo(algo_path).build_logs()
+        result = self.regular_client.algo(algo_path).build_logs()
 
         if u'error' in result:
             print(result)
@@ -74,7 +82,7 @@ def test_get_build_logs(self):
 
     def test_get_build_logs_no_ssl(self):
         client = Algorithmia.client(api_address='https://api.algorithmia.com',
-                                    api_key=unicode(os.environ.get('ALGORITHMIA_API_KEY')), ca_cert=False)
+                                    api_key=self.regular_api_key, ca_cert=False)
         user = unicode(os.environ.get('ALGO_USER_NAME'))
         algo = u'Echo'
         result = client.algo(user + '/' + algo).build_logs()
@@ -97,15 +105,15 @@ def test_edit_org(self):
             "resource_type": "organization"
         }
 
-        response = self.c.edit_org(org_name, obj)
+        response = self.admin_client.edit_org(org_name, obj)
         if type(response) is dict:
             print(response)
         else:
             self.assertEqual(204, response.status_code)
 
     def test_get_template(self):
         filename = "./temptest"
-        response = self.c.get_template("36fd467e-fbfe-4ea6-aa66-df3f403b7132", filename)
+        response = self.admin_client.get_template("36fd467e-fbfe-4ea6-aa66-df3f403b7132", filename)
 
         if type(response) is dict:
             self.assertTrue(u'error' in response or u'message' in response)
@@ -117,7 +125,7 @@ def test_get_template(self):
                 print(e)
 
     def test_get_supported_languages(self):
-        response = self.c.get_supported_languages()
+        response = self.admin_client.get_supported_languages()
         self.assertTrue(response is not None)
 
         if type(response) is not list:
@@ -127,7 +135,7 @@ def test_get_supported_languages(self):
             self.assertTrue(response is not None and language_found)
 
     def test_invite_to_org(self):
-        response = self.c.invite_to_org("a_myOrg38", "a_Mrtest4")
+        response = self.admin_client.invite_to_org("a_myOrg38", "a_Mrtest4")
         if type(response) is dict:
             self.assertTrue(u'error' in response)
         else:
@@ -136,20 +144,20 @@ def test_invite_to_org(self):
     # This test will require updating after the /v1/organizations/{org_name}/errors endpoint has been
     # deployed to the remote environment.
     def test_get_organization_errors(self):
-        response = self.c.get_organization_errors(self.org_name)
+        response = self.admin_client.get_organization_errors(self.admin_org_name)
         self.assertTrue(response is not None)
 
         if type(response) is list:
             self.assertEqual(0, len(response), 'Received unexpected result, should have been 0.')
 
     def test_get_user_errors(self):
-        response = self.c.get_user_errors(self.username)
+        response = self.admin_client.get_user_errors(self.admin_username)
 
         self.assertTrue(response is not None)
         self.assertEqual(0, len(response))
 
     def test_get_algorithm_errors(self):
-        response = self.c.get_algorithm_errors('hello')
+        response = self.admin_client.get_algorithm_errors('hello')
         self.assertTrue(response is not None)
 
         if type(response) is dict:
@@ -158,5 +166,61 @@ def test_get_algorithm_errors(self):
             self.assertEqual(404, response.status_code)
 
 
+    def test_algorithm_programmatic_create_process(self):
+        algorithm_name = "algo_" + str(uuid4()).split("-")[-1]
+        payload = "John"
+        expected_response = "hello John"
+        full_path = self.regular_client.username() + "/" + algorithm_name
+        details = {
+            "summary": "Example Summary",
+            "label": "QA",
+            "tagline": "Example Tagline"
+        }
+        settings = {
+            "source_visibility": "open",
+            "algorithm_environment": self.environment_id,
+            "license": "apl",
+            "network_access": "isolated",
+            "pipeline_enabled": False
+        }
+        created_algo = self.regular_client.algo(full_path)
+        response = created_algo.create(details=details,settings=settings)
+        self.assertEqual(response.name, algorithm_name, "algorithm creation failed")
+
+        # --- Creation complete, compiling
+
+        response = created_algo.compile()
+        git_hash = response.version_info.git_hash
+        algo_with_build = self.regular_client.algo(full_path + "/" + git_hash)
+        self.assertEqual(response.name, created_algo.algoname)
+
+        # --- compiling complete, now testing algorithm request
+        response = algo_with_build.pipe(payload).result
+        self.assertEqual(response, expected_response, "compiling failed")
+
+        # --- testing complete, now publishing new release.
+
+        pub_settings = {"algorithm_callability": "private"}
+        pub_version_info = {
+                           "release_notes": "created programmatically",
+                           "sample_input": payload,
+                           "version_type": "minor"
+                       }
+        pub_details = {"label": "testing123"}
+
+        response = algo_with_build.publish(
+            details=pub_details,
+            settings=pub_settings,
+            version_info=pub_version_info
+        )
+        self.assertEqual(response.version_info.semantic_version, "0.1.0", "Publishing failed, semantic version is not correct.")
+
+        # --- publishing complete, getting additional information
+
+        response = created_algo.info(git_hash)
+
+        self.assertEqual(response.version_info.semantic_version, "0.1.0", "information is incorrect")
+
+
 if __name__ == '__main__':
     unittest.main()