pagure/tests/test_pagure_flask_api_issue_change_status.py

# -*- coding: utf-8 -*-

"""
 (c) 2015-2017 - Copyright Red Hat Inc

 Authors:
   Pierre-Yves Chibon <pingou@pingoured.fr>

"""

from __future__ import unicode_literals, absolute_import

import copy
import datetime
import unittest
import shutil
import sys
import time
import os

import json
from mock import patch, MagicMock

sys.path.insert(
    0, os.path.join(os.path.dirname(os.path.abspath(__file__)), "..")
)

import pagure.lib.query
import pagure.lib.model
import tests


class PagureFlaskApiIssueChangeStatustests(tests.Modeltests):
    """Tests for the flask API of pagure for changing the status of an
    issue
    """

    @patch("pagure.lib.notify.send_email", MagicMock(return_value=True))
    def setUp(self):
        """Set up the environnment, ran before every tests."""
        super(PagureFlaskApiIssueChangeStatustests, self).setUp()

        pagure.config.config["TICKETS_FOLDER"] = None

        tests.create_projects(self.session)
        tests.create_projects_git(os.path.join(self.path, "tickets"))
        tests.create_tokens(self.session)
        tests.create_tokens_acl(self.session)

        # Create normal issue
        repo = pagure.lib.query.get_authorized_project(self.session, "test")
        msg = pagure.lib.query.new_issue(
            session=self.session,
            repo=repo,
            title="Test issue #1",
            content="We should work on this",
            user="pingou",
            private=False,
        )
        self.session.commit()
        self.assertEqual(msg.title, "Test issue #1")

        # Create private issue
        msg = pagure.lib.query.new_issue(
            session=self.session,
            repo=repo,
            title="Test issue #2",
            content="We should work on this",
            user="foo",
            private=True,
        )
        self.session.commit()
        self.assertEqual(msg.title, "Test issue #2")

        # Create project-less token for user foo
        item = pagure.lib.model.Token(
            id="project-less-foo",
            user_id=2,
            project_id=None,
            expiration=datetime.datetime.utcnow()
            + datetime.timedelta(days=30),
        )
        self.session.add(item)
        self.session.commit()
        tests.create_tokens_acl(self.session, token_id="project-less-foo")

        # Create project-less token for user pingou
        item = pagure.lib.model.Token(
            id="project-less-pingou",
            user_id=1,
            project_id=None,
            expiration=datetime.datetime.utcnow()
            + datetime.timedelta(days=30),
        )
        self.session.add(item)
        self.session.commit()
        tests.create_tokens_acl(self.session, token_id="project-less-pingou")

    def test_api_change_status_issue_invalid_project(self):
        """Test the api_change_status_issue method of the flask api."""

        headers = {"Authorization": "token aaabbbcccddd"}

        # Invalid project
        output = self.app.post("/api/0/foobar/issue/1/status", headers=headers)
        self.assertEqual(output.status_code, 404)
        data = json.loads(output.get_data(as_text=True))
        self.assertDictEqual(
            data, {"error": "Project not found", "error_code": "ENOPROJECT"}
        )

    def test_api_change_status_issue_token_not_for_project(self):
        """Test the api_change_status_issue method of the flask api."""

        headers = {"Authorization": "token aaabbbcccddd"}

        # Valid token, wrong project
        output = self.app.post("/api/0/test2/issue/1/status", headers=headers)
        self.assertEqual(output.status_code, 401)
        data = json.loads(output.get_data(as_text=True))
        self.assertEqual(
            pagure.api.APIERROR.EINVALIDTOK.name, data["error_code"]
        )
        self.assertEqual(pagure.api.APIERROR.EINVALIDTOK.value, data["error"])

    def test_api_change_status_issue_invalid_issue(self):
        """Test the api_change_status_issue method of the flask api."""

        headers = {"Authorization": "token aaabbbcccddd"}

        # No issue
        output = self.app.post("/api/0/test/issue/42/status", headers=headers)
        self.assertEqual(output.status_code, 404)
        data = json.loads(output.get_data(as_text=True))
        self.assertDictEqual(
            data, {"error": "Issue not found", "error_code": "ENOISSUE"}
        )

    def test_api_change_status_issue_incomplete(self):
        """Test the api_change_status_issue method of the flask api."""

        headers = {"Authorization": "token aaabbbcccddd"}

        # Check status before
        repo = pagure.lib.query.get_authorized_project(self.session, "test")
        issue = pagure.lib.query.search_issues(self.session, repo, issueid=1)
        self.assertEqual(issue.status, "Open")

        data = {"title": "test issue"}

        # Incomplete request
        output = self.app.post(
            "/api/0/test/issue/1/status", data=data, headers=headers
        )
        self.assertEqual(output.status_code, 400)
        data = json.loads(output.get_data(as_text=True))
        expected_output = {
            "error": "Invalid or incomplete input submitted",
            "error_code": "EINVALIDREQ",
            "errors": {"status": ["Not a valid choice"]},
        }
        if self.get_wtforms_version() >= (3, 0):
            expected_output["errors"]["status"] = ["Not a valid choice."]
        self.assertDictEqual(data, expected_output)

        # No change
        repo = pagure.lib.query.get_authorized_project(self.session, "test")
        issue = pagure.lib.query.search_issues(self.session, repo, issueid=1)
        self.assertEqual(issue.status, "Open")

    def test_api_change_status_issue_no_change(self):
        """Test the api_change_status_issue method of the flask api."""

        headers = {"Authorization": "token aaabbbcccddd"}

        data = {"status": "Open"}

        # Valid request but no change
        output = self.app.post(
            "/api/0/test/issue/1/status", data=data, headers=headers
        )
        self.assertEqual(output.status_code, 200)
        data = json.loads(output.get_data(as_text=True))
        self.assertDictEqual(data, {"message": "No changes"})

        # No change
        repo = pagure.lib.query.get_authorized_project(self.session, "test")
        issue = pagure.lib.query.search_issues(self.session, repo, issueid=1)
        self.assertEqual(issue.status, "Open")

    @patch("pagure.lib.notify.send_email", MagicMock(return_value=True))
    @patch(
        "pagure.lib.query.edit_issue",
        MagicMock(side_effect=pagure.exceptions.PagureException("error")),
    )
    def test_api_change_status_issue_raise_error(self):
        """Test the api_change_status_issue method of the flask api."""
        repo = pagure.lib.query.get_authorized_project(self.session, "test")
        close_status = repo.close_status
        close_status = ["Fixed", "Upstream", "Invalid"]
        repo.close_status = close_status
        self.session.add(repo)
        self.session.commit()

        headers = {"Authorization": "token aaabbbcccddd"}

        data = {"status": "Closed", "close_status": "Fixed"}

        # Valid request
        output = self.app.post(
            "/api/0/test/issue/1/status", data=data, headers=headers
        )
        self.assertEqual(output.status_code, 400)
        data = json.loads(output.get_data(as_text=True))

        self.assertDictEqual(data, {"error": "error", "error_code": "ENOCODE"})

    @patch("pagure.lib.notify.send_email", MagicMock(return_value=True))
    def test_api_change_status_issue(self):
        """Test the api_change_status_issue method of the flask api."""

        headers = {"Authorization": "token aaabbbcccddd"}

        data = {"status": "Fixed"}

        # Valid request
        output = self.app.post(
            "/api/0/test/issue/1/status", data=data, headers=headers
        )
        self.assertEqual(output.status_code, 200)
        data = json.loads(output.get_data(as_text=True))

        self.assertDictEqual(
            data,
            {
                "message": [
                    "Issue status updated to: Closed (was: Open)",
                    "Issue close_status updated to: Fixed",
                ]
            },
        )

        headers = {"Authorization": "token pingou_foo"}

        # Un-authorized issue
        output = self.app.post(
            "/api/0/foo/issue/1/status", data=data, headers=headers
        )
        self.assertEqual(output.status_code, 401)
        data = json.loads(output.get_data(as_text=True))
        self.assertEqual(
            pagure.api.APIERROR.EINVALIDTOK.name, data["error_code"]
        )
        self.assertEqual(pagure.api.APIERROR.EINVALIDTOK.value, data["error"])

    @patch("pagure.lib.notify.send_email", MagicMock(return_value=True))
    def test_api_change_status_issue_closed_status(self):
        """Test the api_change_status_issue method of the flask api."""
        repo = pagure.lib.query.get_authorized_project(self.session, "test")
        close_status = repo.close_status
        close_status = ["Fixed", "Upstream", "Invalid"]
        repo.close_status = close_status
        self.session.add(repo)
        self.session.commit()

        headers = {"Authorization": "token aaabbbcccddd"}

        data = {"status": "Closed", "close_status": "Fixed"}

        # Valid request
        output = self.app.post(
            "/api/0/test/issue/1/status", data=data, headers=headers
        )
        self.assertEqual(output.status_code, 200)
        data = json.loads(output.get_data(as_text=True))

        self.assertDictEqual(
            data,
            {
                "message": [
                    "Issue status updated to: Closed (was: Open)",
                    "Issue close_status updated to: Fixed",
                ]
            },
        )

    @patch("pagure.lib.notify.send_email", MagicMock(return_value=True))
    def test_api_change_status_issue_no_ticket_project_less(self):
        """Test the api_change_status_issue method of the flask api."""

        headers = {"Authorization": "token project-less-foo"}

        data = {"status": "Fixed"}

        # Valid request
        output = self.app.post(
            "/api/0/test/issue/1/status", data=data, headers=headers
        )
        self.assertEqual(output.status_code, 403)
        data = json.loads(output.get_data(as_text=True))

        self.assertDictEqual(
            data,
            {
                "error": "You are not allowed to view this issue",
                "error_code": "EISSUENOTALLOWED",
            },
        )

    @patch("pagure.lib.notify.send_email", MagicMock(return_value=True))
    def test_api_change_status_issue_project_less(self):
        """Test the api_change_status_issue method of the flask api."""

        headers = {"Authorization": "token project-less-pingou"}

        data = {"status": "Fixed"}

        # Valid request
        output = self.app.post(
            "/api/0/test/issue/1/status", data=data, headers=headers
        )
        self.assertEqual(output.status_code, 200)
        data = json.loads(output.get_data(as_text=True))

        self.assertDictEqual(
            data,
            {
                "message": [
                    "Issue status updated to: Closed (was: Open)",
                    "Issue close_status updated to: Fixed",
                ]
            },
        )


if __name__ == "__main__":
    unittest.main(verbosity=2)