Merge pull request #12 from Microsoft/account

Added unit tests and updated readme

README.rst

@@ -20,3 +20,18 @@ Use the standard PYPI packaging flow to push a new release. Make sure to increme
     python setup.py sdist
     python -m twine upload dist/*
 ::
+
+Running Tests
+=============
+The only class we have unit tests for is the ContinuousDeliveryManager class. As features are added, add tests 
+and maintain a high (>80%) code coverage number for this class.
+You can run these tests in the following way:
+::
+    python tests/test_continuous_delivery_manager.py
+::
+
+Code Coverage
+=============
+Code coverage for the vsts_cd_manager.py file should be kept current with any new features. Most of the other code 
+is boiler plate REST API code that could be generated for the most part. You can find out more about how to run
+code coverage here: https://coverage.readthedocs.io/en/coverage-4.4

setup.py

@@ -16,7 +16,7 @@ VERSION = "0.118.0"
 # prerequisite: setuptools
 # http://pypi.python.org/pypi/setuptools
 
-REQUIRES = ["msrest>=0.2.0"]
+REQUIRES = ["msrest>=0.2.0", 'mock']
 
 setup(
     name=NAME,

tests/test_continuous_delivery_manager.py

@@ -0,0 +1,132 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+from __future__ import print_function
+import unittest
+
+from continuous_delivery.models import CiResult
+
+from continuous_delivery.models import CiArtifact
+
+from continuous_delivery.models import CiConfiguration
+
+from continuous_delivery.models import ProvisioningConfigurationSource
+
+from continuous_delivery.models import ProvisioningConfiguration
+from mock import patch, Mock
+from vsts_accounts.models import AccountModel
+from vsts_info_provider.models import TeamProjectInfo, RepositoryInfo, CollectionInfo, VstsInfo
+from vsts_cd_manager.continuous_delivery_manager import ContinuousDeliveryManager
+
+
+class TestContinousDeliveryManager(unittest.TestCase):
+    def fake_callback(self):
+        pass
+
+    def test_constructor(self):
+        cdman = ContinuousDeliveryManager(None)
+        cdman = ContinuousDeliveryManager(self.fake_callback)
+
+    def test_get_vsts_app_id(self):
+        cdman = ContinuousDeliveryManager(None)
+        self.assertEqual('499b84ac-1321-427f-aa17-267ca6975798', cdman.get_vsts_app_id())
+
+    def test_set_azure_web_info(self):
+        cdman = ContinuousDeliveryManager(None)
+        cdman.set_azure_web_info('group1', 'web1', 'fakeCreds', 'sub1', 'subname1', 'tenant1', 'South Central US')
+        self.assertEqual('fakeCreds', cdman._azure_info.credentials)
+        self.assertEqual('group1', cdman._azure_info.resource_group_name)
+        self.assertEqual('sub1', cdman._azure_info.subscription_id)
+        self.assertEqual('subname1', cdman._azure_info.subscription_name)
+        self.assertEqual('tenant1', cdman._azure_info.tenant_id)
+        self.assertEqual('South Central US', cdman._azure_info.webapp_location)
+        self.assertEqual('web1', cdman._azure_info.website_name)
+        cdman.set_azure_web_info(None, None, None, None, None, None, None)
+        self.assertEqual(None, cdman._azure_info.credentials)
+        self.assertEqual(None, cdman._azure_info.resource_group_name)
+        self.assertEqual(None, cdman._azure_info.subscription_id)
+        self.assertEqual(None, cdman._azure_info.subscription_name)
+        self.assertEqual(None, cdman._azure_info.tenant_id)
+        self.assertEqual(None, cdman._azure_info.webapp_location)
+        self.assertEqual(None, cdman._azure_info.website_name)
+
+    def test_set_repository_info(self):
+        cdman = ContinuousDeliveryManager(None)
+        cdman.set_repository_info('repoUrl1', 'master1', 'token1')
+        self.assertEqual('master1', cdman._repo_info.branch)
+        self.assertEqual('token1', cdman._repo_info.git_token)
+        self.assertEqual('repoUrl1', cdman._repo_info.url)
+        cdman.set_repository_info(None, None, None)
+        self.assertEqual(None, cdman._repo_info.branch)
+        self.assertEqual(None, cdman._repo_info.git_token)
+        self.assertEqual(None, cdman._repo_info.url)
+
+    @patch("vsts_cd_manager.continuous_delivery_manager.ContinuousDelivery")
+    @patch("vsts_cd_manager.continuous_delivery_manager.Account")
+    def test_setup_continuous_delivery___account_doesnt_exist(self, mock_account, mock_cd):
+        # Mock the CD Client
+        mocked_cd = mock_cd.return_value
+        # Mock the Account Client
+        mocked_account = mock_account.return_value
+        mocked_account.create_account.return_value = AccountModel()
+        mocked_account.account_exists.return_value = False
+        # create CD manager
+        cdman = ContinuousDeliveryManager(None)
+        # Mock the vsts info call
+        cdman._get_vsts_info = self._mock_get_vsts_info
+        # set required values
+        cdman.set_azure_web_info('group1', 'web1', 'fakeCreds', 'sub1', 'subname1', 'tenant1', 'South Central US')
+        cdman.set_repository_info('repoUrl1', 'master1', 'token1')
+        # call setup
+        with self.assertRaises(RuntimeError) as context:
+            cdman.setup_continuous_delivery('staging', 'AspNetWap', "account1", False, 'token2')
+        self.assertTrue('does not exist' in str(context.exception))
+
+    @patch("vsts_cd_manager.continuous_delivery_manager.ContinuousDelivery")
+    @patch("vsts_cd_manager.continuous_delivery_manager.Account")
+    def test_setup_continuous_delivery___create_account(self, mock_account, mock_cd):
+        # Mock the CD Client
+        mocked_cd = mock_cd.return_value
+        mocked_cd.provisioning_configuration.return_value = self._get_provisioning_config('queued', '')
+        mocked_cd.get_provisioning_configuration.return_value = self._get_provisioning_config('succeeded', '')
+        # Mock the Account Client
+        mocked_account = mock_account.return_value
+        mocked_account.create_account.return_value = AccountModel('111', 'collection111')
+        mocked_account.account_exists.return_value = False
+        # create CD manager
+        cdman = ContinuousDeliveryManager(None)
+        # Mock the vsts info call
+        cdman._get_vsts_info = self._mock_get_vsts_info
+        # set required values
+        cdman.set_azure_web_info('group1', 'web1', 'fakeCreds', 'sub1', 'subname1', 'tenant1', 'South Central US')
+        cdman.set_repository_info('repoUrl1', 'master1', 'token1')
+        # call setup
+        result = cdman.setup_continuous_delivery('staging', 'AspNetWap', "account1", True, 'token2')
+        self.assertEqual('SUCCESS', result.status)
+        self.assertTrue("The Team Services account 'https://account1.visualstudio.com' was created" in result.status_message)
+        self.assertEqual('https://portal.azure.com/#resource/subscriptions/sub1/resourceGroups/group1/providers/Microsoft.Web/sites/web1/vstscd', result.azure_continuous_delivery_url)
+        self.assertEqual('group1', result.azure_resource_group)
+        self.assertEqual('sub1', result.azure_subscription_id)
+        self.assertEqual('web1', result.azure_website_name)
+        self.assertEqual(True, result.vsts_account_created)
+        self.assertEqual('https://account1.visualstudio.com', result.vsts_account_url)
+        self.assertEqual('https://account1.visualstudio.com/333/_build?_a=simple-process&definitionId=123', result.vsts_build_def_url)
+        self.assertEqual('https://account1.visualstudio.com/333/_apps/hub/ms.vss-releaseManagement-web.hub-explorer?definitionId=321&_a=releases', result.vsts_release_def_url)
+
+    def _mock_get_vsts_info(self, vsts_repo_url, cred):
+        collection_info = CollectionInfo('111', 'collection111', 'https://collection111.visualstudio.com')
+        project_info = TeamProjectInfo('333', 'project1', 'https://collection111.visualstudio.com/project1', 'good', '1')
+        repository_info = RepositoryInfo('222', 'repo222', 'https://collection111.visualstudio.com/project1/_git/repo222', project_info)
+        return VstsInfo('server1', collection_info, repository_info)
+
+    def _get_provisioning_config(self, status, status_message):
+        ci_config = CiConfiguration(
+            CiArtifact('333', 'project1', 'https://collection111.visualstudio.com/project1'),
+            CiArtifact('123', 'builddef123', 'https://collection111.visualstudio.com/project1/build/definition/123'),
+            CiArtifact('321', 'releasedef321', 'https://collection111.visualstudio.com/project1/release/definition/321'),
+            CiResult(status, status_message))
+        return ProvisioningConfiguration('abcd', None, None, ci_config)
+
+if __name__ == '__main__':
+    unittest.main()