add unit tests

awx/main/tests/unit/api/serializers/conftest.py

@@ -0,0 +1,46 @@
+
+import pytest
+
+@pytest.fixture
+def get_related_assert():
+    def fn(model_obj, related, resource_name, related_resource_name):
+        assert related_resource_name in related
+        assert related[related_resource_name] == '/api/v1/%s/%d/%s/' % (resource_name, model_obj.pk, related_resource_name)
+    return fn
+
+@pytest.fixture
+def get_related_mock_and_run():
+    def fn(serializer_class, model_obj):
+        serializer = serializer_class()
+        related = serializer.get_related(model_obj)
+        return related
+    return fn
+
+@pytest.fixture
+def test_get_related(get_related_assert, get_related_mock_and_run):
+    def fn(serializer_class, model_obj, resource_name, related_resource_name):
+        related = get_related_mock_and_run(serializer_class, model_obj)
+        get_related_assert(model_obj, related, resource_name, related_resource_name)
+        return related
+    return fn
+
+@pytest.fixture
+def get_summary_fields_assert():
+    def fn(summary, summary_field_name):
+        assert summary_field_name in summary
+    return fn
+
+@pytest.fixture
+def get_summary_fields_mock_and_run():
+    def fn(serializer_class, model_obj):
+        serializer = serializer_class()
+        return serializer.get_summary_fields(model_obj)
+    return fn
+
+@pytest.fixture
+def test_get_summary_fields(get_summary_fields_mock_and_run, get_summary_fields_assert):
+    def fn(serializer_class, model_obj, summary_field_name):
+        summary = get_summary_fields_mock_and_run(serializer_class, model_obj)
+        get_summary_fields_assert(summary, summary_field_name)
+        return summary 
+    return fn

awx/main/tests/unit/api/serializers/test_inventory_serializers.py

@@ -0,0 +1,47 @@
+# Python
+import pytest
+import mock
+from mock import PropertyMock
+
+# AWX
+from awx.api.serializers import (
+    CustomInventoryScriptSerializer,
+)
+from awx.main.models import (
+    CustomInventoryScript,
+    User,
+)
+
+#DRF
+from rest_framework.request import Request
+from rest_framework.test import (
+    APIRequestFactory,
+    force_authenticate,
+)
+
+class TestCustomInventoryScriptSerializer(object):
+
+    @pytest.mark.parametrize("superuser,sysaudit,admin_role,value",
+                             ((True, False, False, '#!/python'),
+                              (False, True, False, '#!/python'),
+                              (False, False, True, '#!/python'),
+                              (False, False, False, None)))
+    def test_to_representation_orphan(self, superuser, sysaudit, admin_role, value):
+        with mock.patch.object(CustomInventoryScriptSerializer, 'get_summary_fields', return_value={}):
+                User.add_to_class('is_system_auditor', sysaudit)
+                user = User(username="root", is_superuser=superuser)
+                roles = [user] if admin_role else []
+
+                with mock.patch('awx.main.models.CustomInventoryScript.admin_role', new_callable=PropertyMock, return_value=roles):
+                    cis = CustomInventoryScript(pk=1, script='#!/python')
+                    serializer = CustomInventoryScriptSerializer()
+
+                    factory = APIRequestFactory()
+                    wsgi_request = factory.post("/inventory_script/1", {'id':1}, format="json")
+                    force_authenticate(wsgi_request, user)
+
+                    request = Request(wsgi_request)
+                    serializer.context['request'] = request
+
+                    representation = serializer.to_representation(cis)
+                    assert representation['script'] == value

awx/main/tests/unit/api/serializers/test_job_serializers.py

@@ -0,0 +1,91 @@
+# Python
+import pytest
+import mock
+import json
+
+# AWX
+from awx.api.serializers import (
+    JobSerializer,
+    JobOptionsSerializer,
+)
+from awx.main.models import (
+    Label,
+    Job,
+)
+
+def mock_JT_resource_data():
+    return ({}, [])
+
+@pytest.fixture
+def job_template(mocker):
+    mock_jt = mocker.MagicMock(pk=5)
+    mock_jt.resource_validation_data = mock_JT_resource_data
+    return mock_jt
+
+@pytest.fixture
+def job(mocker, job_template):
+    return mocker.MagicMock(pk=5, job_template=job_template)
+
+@pytest.fixture
+def labels(mocker):
+    return [Label(id=x, name='label-%d' % x) for x in xrange(0, 25)]
+
+@pytest.fixture
+def jobs(mocker):
+    return [Job(id=x, name='job-%d' % x) for x in xrange(0, 25)]
+
+@mock.patch('awx.api.serializers.UnifiedJobTemplateSerializer.get_related', lambda x,y: {})
+@mock.patch('awx.api.serializers.JobOptionsSerializer.get_related', lambda x,y: {})
+class TestJobSerializerGetRelated():
+    @pytest.mark.parametrize("related_resource_name", [
+        'job_events',
+        'job_plays',
+        'job_tasks',
+        'relaunch',
+        'labels',
+    ])
+    def test_get_related(self, test_get_related, job, related_resource_name):
+        test_get_related(JobSerializer, job, 'jobs', related_resource_name)
+
+    def test_job_template_absent(self, job):
+        job.job_template = None
+        serializer = JobSerializer()
+        related = serializer.get_related(job)
+        assert 'job_template' not in related
+
+    def test_job_template_present(self, get_related_mock_and_run, job):
+        related = get_related_mock_and_run(JobSerializer, job)
+        assert 'job_template' in related
+        assert related['job_template'] == '/api/v1/%s/%d/' % ('job_templates', job.job_template.pk)
+
+@mock.patch('awx.api.serializers.BaseSerializer.to_representation', lambda self,obj: {
+    'extra_vars': obj.extra_vars})
+class TestJobSerializerSubstitution():
+
+    def test_survey_password_hide(self, mocker):
+        job = mocker.MagicMock(**{
+            'display_extra_vars.return_value': '{\"secret_key\": \"$encrypted$\"}',
+            'extra_vars.return_value': '{\"secret_key\": \"my_password\"}'})
+        serializer = JobSerializer(job)
+        rep = serializer.to_representation(job)
+        extra_vars = json.loads(rep['extra_vars'])
+        assert extra_vars['secret_key'] == '$encrypted$'
+        job.display_extra_vars.assert_called_once_with()
+        assert 'my_password' not in extra_vars
+
+@mock.patch('awx.api.serializers.BaseSerializer.get_summary_fields', lambda x,y: {})
+class TestJobOptionsSerializerGetSummaryFields():
+    def test__summary_field_labels_10_max(self, mocker, job_template, labels):
+        job_template.labels.all = mocker.MagicMock(**{'order_by.return_value': labels})
+        job_template.labels.all.return_value = job_template.labels.all
+
+        serializer = JobOptionsSerializer()
+        summary_labels = serializer._summary_field_labels(job_template)
+
+        job_template.labels.all.order_by.assert_called_with('name')
+        assert len(summary_labels['results']) == 10
+        assert summary_labels['results'] == [{'id': x.id, 'name': x.name} for x in labels[:10]]
+
+    def test_labels_exists(self, test_get_summary_fields, job_template):
+        test_get_summary_fields(JobOptionsSerializer, job_template, 'labels')
+

awx/main/tests/unit/api/serializers/test_job_template_serializers.py

@@ -0,0 +1,108 @@
+# Python
+import pytest
+import mock
+
+# AWX
+from awx.api.serializers import (
+    JobTemplateSerializer,
+)
+from awx.main.models import (
+    Job,
+)
+
+#DRF
+from rest_framework import serializers
+
+def mock_JT_resource_data():
+    return ({}, [])
+
+@pytest.fixture
+def job_template(mocker):
+    mock_jt = mocker.MagicMock(pk=5)
+    mock_jt.resource_validation_data = mock_JT_resource_data
+    return mock_jt
+
+@pytest.fixture
+def job(mocker, job_template):
+    return mocker.MagicMock(pk=5, job_template=job_template)
+
+@pytest.fixture
+def jobs(mocker):
+    return [Job(id=x, name='job-%d' % x) for x in xrange(0, 25)]
+
+@mock.patch('awx.api.serializers.UnifiedJobTemplateSerializer.get_related', lambda x,y: {})
+@mock.patch('awx.api.serializers.JobOptionsSerializer.get_related', lambda x,y: {})
+class TestJobTemplateSerializerGetRelated():
+    @pytest.mark.parametrize("related_resource_name", [
+        'jobs',
+        'schedules',
+        'activity_stream',
+        'launch',
+        'notification_templates_any',
+        'notification_templates_success',
+        'notification_templates_error',
+        'survey_spec',
+        'labels',
+        'callback',
+    ])
+    def test_get_related(self, test_get_related, job_template, related_resource_name):
+        test_get_related(JobTemplateSerializer, job_template, 'job_templates', related_resource_name)
+
+    def test_callback_absent(self, get_related_mock_and_run, job_template):
+        job_template.host_config_key = None
+        related = get_related_mock_and_run(JobTemplateSerializer, job_template)
+        assert 'callback' not in related
+
+class TestJobTemplateSerializerGetSummaryFields():
+    def test__recent_jobs(self, mocker, job_template, jobs):
+
+        job_template.jobs.all = mocker.MagicMock(**{'order_by.return_value': jobs})
+        job_template.jobs.all.return_value = job_template.jobs.all
+
+        serializer = JobTemplateSerializer()
+        recent_jobs = serializer._recent_jobs(job_template)
+
+        job_template.jobs.all.assert_called_once_with()
+        job_template.jobs.all.order_by.assert_called_once_with('-created')
+        assert len(recent_jobs) == 10
+        for x in jobs[:10]:
+            assert recent_jobs == [{'id': x.id, 'status': x.status, 'finished': x.finished} for x in jobs[:10]]
+
+    def test_survey_spec_exists(self, test_get_summary_fields, mocker, job_template):
+        job_template.survey_spec = {'name': 'blah', 'description': 'blah blah'}
+        test_get_summary_fields(JobTemplateSerializer, job_template, 'survey')
+
+    def test_survey_spec_absent(self, get_summary_fields_mock_and_run, job_template):
+        job_template.survey_spec = None
+        summary = get_summary_fields_mock_and_run(JobTemplateSerializer, job_template)
+        assert 'survey' not in summary
+
+    @pytest.mark.skip(reason="RBAC needs to land")
+    def test_can_copy_true(self, mocker, job_template):
+        pass
+
+    @pytest.mark.skip(reason="RBAC needs to land")
+    def test_can_copy_false(self, mocker, job_template):
+        pass
+
+    @pytest.mark.skip(reason="RBAC needs to land")
+    def test_can_edit_true(self, mocker, job_template):
+        pass
+
+    @pytest.mark.skip(reason="RBAC needs to land")
+    def test_can_edit_false(self, mocker, job_template):
+        pass
+
+class TestJobTemplateSerializerValidation(object):
+
+    good_extra_vars = ["{\"test\": \"keys\"}", "---\ntest: key"]
+    bad_extra_vars = ["{\"test\": \"keys\"", "---\ntest: [2"]
+
+    def test_validate_extra_vars(self):
+        serializer = JobTemplateSerializer()
+        for ev in self.good_extra_vars:
+            serializer.validate_extra_vars(ev)
+        for ev in self.bad_extra_vars:
+            with pytest.raises(serializers.ValidationError):
+                serializer.validate_extra_vars(ev)
+

awx/main/tests/unit/api/serializers/test_workflow_serializers.py

@@ -0,0 +1,154 @@
+# Python
+import pytest
+import mock
+
+# AWX
+from awx.api.serializers import (
+    WorkflowJobTemplateSerializer,
+    WorkflowNodeBaseSerializer,
+    WorkflowJobTemplateNodeSerializer,
+    WorkflowJobNodeSerializer,
+)
+from awx.main.models import (
+    Job,
+    WorkflowJobTemplateNode,
+    WorkflowJob,
+    WorkflowJobNode,
+)
+
+@mock.patch('awx.api.serializers.UnifiedJobTemplateSerializer.get_related', lambda x,y: {})
+class TestWorkflowJobTemplateSerializerGetRelated():
+    @pytest.fixture
+    def workflow_job_template(self, workflow_job_template_factory):
+        wfjt = workflow_job_template_factory('hello world', persisted=False).workflow_job_template
+        wfjt.pk = 3
+        return wfjt
+
+    @pytest.mark.parametrize("related_resource_name", [
+        'jobs',
+        'launch',
+        'workflow_nodes',
+    ])
+    def test_get_related(self, mocker, test_get_related, workflow_job_template, related_resource_name):
+        test_get_related(WorkflowJobTemplateSerializer,
+                         workflow_job_template,
+                         'workflow_job_templates',
+                         related_resource_name)
+
+@mock.patch('awx.api.serializers.BaseSerializer.get_related', lambda x,y: {})
+class TestWorkflowNodeBaseSerializerGetRelated():
+    @pytest.fixture
+    def job_template(self, job_template_factory):
+        jt = job_template_factory(name="blah", persisted=False).job_template
+        jt.pk = 1
+        return jt
+    
+    @pytest.fixture
+    def workflow_job_template_node_related(self, job_template):
+        return WorkflowJobTemplateNode(pk=1, unified_job_template=job_template)
+
+    @pytest.fixture
+    def workflow_job_template_node(self):
+        return WorkflowJobTemplateNode(pk=1)
+
+    def test_workflow_unified_job_template_present(self, get_related_mock_and_run, workflow_job_template_node_related):
+        related = get_related_mock_and_run(WorkflowNodeBaseSerializer, workflow_job_template_node_related)
+        assert 'unified_job_template' in related
+        assert related['unified_job_template'] == '/api/v1/%s/%d/' % ('job_templates', workflow_job_template_node_related.unified_job_template.pk)
+
+    def test_workflow_unified_job_template_absent(self, workflow_job_template_node):
+        related = WorkflowJobTemplateNodeSerializer().get_related(workflow_job_template_node)
+        assert 'unified_job_template' not in related
+
+@mock.patch('awx.api.serializers.WorkflowNodeBaseSerializer.get_related', lambda x,y: {})
+class TestWorkflowJobTemplateNodeSerializerGetRelated():
+    @pytest.fixture
+    def workflow_job_template_node(self):
+        return WorkflowJobTemplateNode(pk=1)
+
+    @pytest.fixture
+    def workflow_job_template(self, workflow_job_template_factory):
+        wfjt = workflow_job_template_factory("bliggity", persisted=False).workflow_job_template
+        wfjt.pk = 1
+        return wfjt
+
+    @pytest.fixture
+    def job_template(self, job_template_factory):
+        jt = job_template_factory(name="blah", persisted=False).job_template
+        jt.pk = 1
+        return jt
+
+    @pytest.fixture
+    def workflow_job_template_node_related(self, workflow_job_template_node, workflow_job_template):
+        workflow_job_template_node.workflow_job_template = workflow_job_template
+        return workflow_job_template_node
+
+    @pytest.mark.parametrize("related_resource_name", [
+        'success_nodes',
+        'failure_nodes',
+        'always_nodes',
+    ])
+    def test_get_related(self, test_get_related, workflow_job_template_node, related_resource_name):
+        test_get_related(WorkflowJobTemplateNodeSerializer,
+                         workflow_job_template_node,
+                         'workflow_job_template_nodes',
+                         related_resource_name)
+
+    def test_workflow_job_template_present(self, get_related_mock_and_run, workflow_job_template_node_related):
+        related = get_related_mock_and_run(WorkflowJobTemplateNodeSerializer, workflow_job_template_node_related)
+        assert 'workflow_job_template' in related
+        assert related['workflow_job_template'] == '/api/v1/%s/%d/' % ('workflow_job_templates', workflow_job_template_node_related.workflow_job_template.pk)
+
+    def test_workflow_job_template_absent(self, workflow_job_template_node):
+        related = WorkflowJobTemplateNodeSerializer().get_related(workflow_job_template_node)
+        assert 'workflow_job_template' not in related
+
+
+@mock.patch('awx.api.serializers.WorkflowNodeBaseSerializer.get_related', lambda x,y: {})
+class TestWorkflowJobNodeSerializerGetRelated():
+    @pytest.fixture
+    def workflow_job_node(self):
+        return WorkflowJobNode(pk=1)
+
+    @pytest.fixture
+    def workflow_job(self):
+        return WorkflowJob(pk=1)
+
+    @pytest.fixture
+    def job(self):
+        return Job(name="blah", pk=1)
+
+    @pytest.fixture
+    def workflow_job_node_related(self, workflow_job_node, workflow_job, job):
+        workflow_job_node.workflow_job = workflow_job
+        workflow_job_node.job = job
+        return workflow_job_node
+
+    @pytest.mark.parametrize("related_resource_name", [
+        'success_nodes',
+        'failure_nodes',
+        'always_nodes',
+    ])
+    def test_get_related(self, test_get_related, workflow_job_node, related_resource_name):
+        test_get_related(WorkflowJobNodeSerializer,
+                         workflow_job_node,
+                         'workflow_job_nodes',
+                         related_resource_name)
+
+    def test_workflow_job_present(self, get_related_mock_and_run, workflow_job_node_related):
+        related = get_related_mock_and_run(WorkflowJobNodeSerializer, workflow_job_node_related)
+        assert 'workflow_job' in related
+        assert related['workflow_job'] == '/api/v1/%s/%d/' % ('workflow_jobs', workflow_job_node_related.workflow_job.pk)
+
+    def test_workflow_job_absent(self, workflow_job_node):
+        related = WorkflowJobNodeSerializer().get_related(workflow_job_node)
+        assert 'workflow_job' not in related
+
+    def test_job_present(self, get_related_mock_and_run, workflow_job_node_related):
+        related = get_related_mock_and_run(WorkflowJobNodeSerializer, workflow_job_node_related)
+        assert 'job' in related
+        assert related['job'] == '/api/v1/%s/%d/' % ('jobs', workflow_job_node_related.job.pk)
+
+    def test_job_absent(self, workflow_job_node):
+        related = WorkflowJobNodeSerializer().get_related(workflow_job_node)
+        assert 'job' not in related