<reponame>cmltaWt0/edx-load-tests
"""
This file holds the different tasks used for the Discussion API tests
"""
import random

from locust import task

from ..dapi import DiscussionsApiTasks
import dapi_constants


class GetThreadsTask(DiscussionsApiTasks):
    """
    Task for GETting a single thread
    """
    @task
    def get_thread(self):
        """
        GET a thread

        /api/discussion/v1/threads/{thread_id}

        Calls made:
        GET_thread
        """
        choice = random.choice(self.thread_id_list)
        url = "/api/discussion/v1/threads/{}".format(choice)
        self.client.get(url=url, verify=False, name="GET_thread")
        self.wait_then_stop()


class GetThreadListTask(DiscussionsApiTasks):

    @task
    def get_thread_list(self, return_id=False):
        """
        GET a thread list

        /api/discussion/v1/threads/?course_id={}...

        Calls made:
        GET_thread_list
        """
        self.get_random_thread(verbose=self.verbose)
        self.wait_then_stop()


class GetThreadWithCommentsTask(DiscussionsApiTasks):
    """
    Task for GETting a thread list and reporting it's comment_count
    """
    @task
    def get_thread_with_comments(self):
        """
        GET a thread and then report it's comment_count

        /api/discussion/v1/threads/?course_id={}...

        Calls made:
        GET_thread_list
        GET_thread
        """
        thread = self.get_random_thread(verbose=self.verbose, prioritize_comments=True)
        url = "/api/discussion/v1/threads/{}".format(thread["id"])
        comment_count = thread["comment_count"]
        rounded_count = int(round(comment_count / 25) * 25)
        name = "Comment_Range:{}-{}".format(rounded_count, rounded_count + 25)
        self.client.get(url=url, verify=False, name=name)
        self.wait_then_stop()


class GetCommentsTask(DiscussionsApiTasks):
    """
    Tasks for GETting comments
    """

    @task
    def get_comment_list(self):
        """
        GET the comment_list

        /api/discussion/v1/comments/?thread_id={}...

        Calls made:
        GET_thread_list
        GET_comment_list
        """
        thread = self.get_random_thread(page=1, page_size=10, prioritize_comments=True)
        self.wait()
        self.get_random_comment(thread=thread, verbose=self.verbose)
        self.wait_then_stop()

    def _get_comment_and_response_count(self, thread_id):
        """
        Returns the comment_count and response_count for a Thread

        This helper method is used when requiring verbose outputs for threads
        that have high comment_counts. For example, a response with
        1000 comment.

        Calls made:
        GET_thread

        Args:
            thread_id (str): Thread to get the comment_count and response_count

        Returns:
            (tuple): (comment_count, response_count)
        """
        url = "/api/discussion/v1/threads/{}/".format(thread_id)
        response = self.client.get(url, verify=False, name="GET_thread")
        if response.status_code == 200:
            response = response.json()
            return response["comment_count"], response["response_count"]
        else:
            print "{}: {}".format(response.status_code, response.content[0:200])


class PatchThreadsTask(DiscussionsApiTasks):
    """
    Task for PATCH requests for threads

    /api/discussion/v1/threads/{thread_id}

    EditThread uses the staff role to edit while student roles vote, flag,
    and follow.
    """
    def _get_thread_id(self):
        """
        Returns the id of a random thread.
        """
        thread = self.get_random_thread(page=1, page_size=10)
        self.wait()
        if not thread:
            self.stop()
        return thread["id"]

    @task(51)
    def patch_edit_thread(self):
        """
        Edit a thread's raw_body

        Calls made:
        GET_thread_list
        PATCH_thread
        """
        new_body_size = random.choice(dapi_constants.BODY.keys())
        data = {"raw_body": dapi_constants.BODY[new_body_size]}

        name = "edit_thread_with_{}".format(new_body_size) if self.verbose else "PATCH_thread"

        self.patch_thread(
            thread_id=self._get_thread_id(),
            data=data,
            name=name
        )
        self.wait_then_stop()

    @task(3)
    def follow_thread(self):
        """
        Follow a thread

        Calls made:
        GET_thread_list
        PATCH_thread
        """
        data = {"following": random.choice(["true", "false"])}
        name = "following_thread" if self.verbose else "PATCH_thread"
        self.patch_thread(
            thread_id=self._get_thread_id(),
            data=data,
            name=name,
        )
        self.wait_then_stop()

    @task(1)
    def abuse_flag_thread(self):
        """
        Flag a thread with

        Calls made:
        GET_thread_list
        PATCH_thread
        """
        data = {"abuse_flagged": random.choice(["true", "false"])}
        name = "abuse_flag_thread" if self.verbose else "PATCH_thread"
        self.patch_thread(
            thread_id=self._get_thread_id(),
            data=data,
            name=name,
        )
        self.wait_then_stop()

    @task(47)
    def vote_on_thread(self):
        """
        Vote on a thread

        Calls made:
        GET_thread_list
        PATCH_thread
        """
        data = {"voted": random.choice(["true", "false"])}
        name = "vote_on_thread" if self.verbose else "PATCH_thread"
        self.patch_thread(
            thread_id=self._get_thread_id(),
            data=data,
            name=name,

        )
        self.wait_then_stop()


class PatchCommentsTask(DiscussionsApiTasks):
    """
    Task for PATCH requests for comments

    /api/discussion/v1/comments/{comment_id}

    A response can only be edited, flagged, and voted on.
    A comment can only be edited and flagged.
    """

    def _get_comment_id(self):
        """
        Returns the id of a random comment from a random thread (of a random
        page).

        """
        page_size = random.choice(dapi_constants.PAGE_SIZE)
        thread = self.get_random_thread(page_size=page_size, prioritize_comments=True)
        self.wait()
        if not thread:
            self.stop()
        comment = self.get_random_comment(thread=thread)
        self.wait()
        if not comment:
            self.stop()
        return comment["id"]

    @task(30)
    def edit_comment(self):
        """
        Edit a comments's raw_body

        Calls made:
        GET_thread_list
        GET_comment_list
        PATCH_comment
        """
        new_body_size = random.choice(dapi_constants.BODY.keys())
        data = {"raw_body": dapi_constants.BODY[new_body_size]}
        name = "edit_comment_with_{}".format(new_body_size) if self.verbose else "PATCH_comment"
        self.patch_comment(
            comment_id=self._get_comment_id(),
            data=data,
            name=name
        )
        self.wait_then_stop()

    @task(50)
    def vote_on_comment(self):
        """
        Vote on a comment_response

        Calls made:
        GET_thread_list
        GET_comment_list
        PATCH_comment
        """
        data = {"voted": random.choice(["true", "false"])}
        name = "vote_on_comment" if self.verbose else "PATCH_comment"
        self.patch_comment(
            comment_id=self._get_comment_id(),
            data=data,
            name=name
        )
        self.wait_then_stop()

    @task(4)
    def abuse_flag_comment(self):
        """
        Flag a thread with

        Calls made:
        GET_thread_list
        GET_comment_list
        PATCH_comment
        """
        data = {"abuse_flagged": random.choice(["true", "false"])}
        name = "abuse_flag_comment" if self.verbose else "PATCH_comment"
        self.patch_comment(
            comment_id=self._get_comment_id(),
            data=data,
            name=name
        )
        self.wait_then_stop()


class PostThreadsTask(DiscussionsApiTasks):
    """
    Task for POSTing thread

    /api/discussion/v1/threads
    """

    @task
    def create_thread(self):
        """
        POST a thread

        Calls made:
        POST_thread
        """
        self.post_thread()
        self.wait_then_stop()


class PostCommentsTask(DiscussionsApiTasks):
    """
    Task for POSTing comments

    /api/discussion/v1/comments
    """

    @task(2)
    def post_response(self):
        """
        POST a response (1st level comment) and adds the id to the response list

        Calls made:
        GET_thread_list
        POST_comment_response
        """
        page_size = random.choice(dapi_constants.PAGE_SIZE)
        thread = self.get_random_thread(page_size=page_size)
        self.wait()
        if not thread:
            self.stop()
        self.create_response(thread_id=thread["id"])
        self.wait_then_stop()

    @task(1)
    def post_comment(self):
        """
        POST a comment (2nd level comment) to the response list

        Calls made:
        GET_thread_list
        POST_comment_response
        POST_comment_comment
        """
        page_size = random.choice(dapi_constants.PAGE_SIZE)
        thread = self.get_random_thread(page_size=page_size)
        self.wait()
        if not thread:
            self.stop()
        response = self.create_response(thread_id=thread["id"])
        self.wait()
        if not response:
            self.stop()
        self.create_comment(comment_id=response["id"], thread_id=response["thread_id"])
        self.wait_then_stop()


class DeleteThreadsTask(DiscussionsApiTasks):
    """
    Tasks for DELETE thread

    /api/discussion/v1/threads/{thread_id}
    """

    @task
    def delete_thread(self):
        """
        DELETE a thread

        A thread will be created with POST and then DELETED.

        Calls made:
        POST_thread
        DELETE_thread
        """
        thread = self.post_thread()
        self.wait()
        if not thread:
            self.stop()
        self.delete_course_thread(thread["id"])
        self.wait_then_stop()


class DeleteCommentsTask(DiscussionsApiTasks):
    """
    DELETEs a comment from a list of responses/comments

    /api/discussion/v1/comments/{comment_id}
    """

    @task
    def delete_response(self):
        """
        DELETE a response

        A response will be created with POST for randomly selected thread
        and then DELETED.

        Calls made:
        GET_thread_list
        POST_response
        DELETE_response
        """
        thread = self.get_random_thread(page=1, page_size=10)
        self.wait()
        if not thread:
            self.stop()
        response = self.create_response(thread_id=thread["id"])
        self.wait()
        if not response:
            self.stop()
        self.delete_comment(comment_id=response["id"])
        self.wait_then_stop()

    @task
    def delete_response_comment(self):
        """
        DELETE a response

        Retrieve threads to retrieve a response. Create a comment and then
        delete the comment.

        Calls made:
        GET_thread_list
        GET_response_list
        POST_response_comment
        DELETE_response_comment
        """
        thread = self.get_random_thread(page=1, page_size=10)
        self.wait()
        if not thread:
            self.stop()
        response = self.get_random_comment(thread=thread)
        self.wait()
        if not response:
            self.stop()
        new_comment = self.create_comment(comment_id=response["id"], thread_id=thread["id"])
        self.wait()
        if not new_comment:
            self.stop()
        self.delete_comment(comment_id=new_comment["id"])
        self.wait_then_stop()

"""
This file holds the different tasks used for the Discussion API tests
"""
import random

from locust import task

from ..dapi import DiscussionsApiTasks
import dapi_constants


class GetThreadsTask(DiscussionsApiTasks):
    """
    Task for GETting a single thread
    """
    @task
    def get_thread(self):
        """
        GET a thread

        /api/discussion/v1/threads/{thread_id}

        Calls made:
        GET_thread
        """
        choice = random.choice(self.thread_id_list)
        url = "/api/discussion/v1/threads/{}".format(choice)
        self.client.get(url=url, verify=False, name="GET_thread")
        self.wait_then_stop()


class GetThreadListTask(DiscussionsApiTasks):

    @task
    def get_thread_list(self, return_id=False):
        """
        GET a thread list

        /api/discussion/v1/threads/?course_id={}...

        Calls made:
        GET_thread_list
        """
        self.get_random_thread(verbose=self.verbose)
        self.wait_then_stop()


class GetThreadWithCommentsTask(DiscussionsApiTasks):
    """
    Task for GETting a thread list and reporting it's comment_count
    """
    @task
    def get_thread_with_comments(self):
        """
        GET a thread and then report it's comment_count

        /api/discussion/v1/threads/?course_id={}...

        Calls made:
        GET_thread_list
        GET_thread
        """
        thread = self.get_random_thread(verbose=self.verbose, prioritize_comments=True)
        url = "/api/discussion/v1/threads/{}".format(thread["id"])
        comment_count = thread["comment_count"]
        rounded_count = int(round(comment_count / 25) * 25)
        name = "Comment_Range:{}-{}".format(rounded_count, rounded_count + 25)
        self.client.get(url=url, verify=False, name=name)
        self.wait_then_stop()


class GetCommentsTask(DiscussionsApiTasks):
    """
    Tasks for GETting comments
    """

    @task
    def get_comment_list(self):
        """
        GET the comment_list

        /api/discussion/v1/comments/?thread_id={}...

        Calls made:
        GET_thread_list
        GET_comment_list
        """
        thread = self.get_random_thread(page=1, page_size=10, prioritize_comments=True)
        self.wait()
        self.get_random_comment(thread=thread, verbose=self.verbose)
        self.wait_then_stop()

    def _get_comment_and_response_count(self, thread_id):
        """
        Returns the comment_count and response_count for a Thread

        This helper method is used when requiring verbose outputs for threads
        that have high comment_counts. For example, a response with
        1000 comment.

        Calls made:
        GET_thread

        Args:
            thread_id (str): Thread to get the comment_count and response_count

        Returns:
            (tuple): (comment_count, response_count)
        """
        url = "/api/discussion/v1/threads/{}/".format(thread_id)
        response = self.client.get(url, verify=False, name="GET_thread")
        if response.status_code == 200:
            response = response.json()
            return response["comment_count"], response["response_count"]
        else:
            print "{}: {}".format(response.status_code, response.content[0:200])


class PatchThreadsTask(DiscussionsApiTasks):
    """
    Task for PATCH requests for threads

    /api/discussion/v1/threads/{thread_id}

    EditThread uses the staff role to edit while student roles vote, flag,
    and follow.
    """
    def _get_thread_id(self):
        """
        Returns the id of a random thread.
        """
        thread = self.get_random_thread(page=1, page_size=10)
        self.wait()
        if not thread:
            self.stop()
        return thread["id"]

    @task(51)
    def patch_edit_thread(self):
        """
        Edit a thread's raw_body

        Calls made:
        GET_thread_list
        PATCH_thread
        """
        new_body_size = random.choice(dapi_constants.BODY.keys())
        data = {"raw_body": dapi_constants.BODY[new_body_size]}

        name = "edit_thread_with_{}".format(new_body_size) if self.verbose else "PATCH_thread"

        self.patch_thread(
            thread_id=self._get_thread_id(),
            data=data,
            name=name
        )
        self.wait_then_stop()

    @task(3)
    def follow_thread(self):
        """
        Follow a thread

        Calls made:
        GET_thread_list
        PATCH_thread
        """
        data = {"following": random.choice(["true", "false"])}
        name = "following_thread" if self.verbose else "PATCH_thread"
        self.patch_thread(
            thread_id=self._get_thread_id(),
            data=data,
            name=name,
        )
        self.wait_then_stop()

    @task(1)
    def abuse_flag_thread(self):
        """
        Flag a thread with

        Calls made:
        GET_thread_list
        PATCH_thread
        """
        data = {"abuse_flagged": random.choice(["true", "false"])}
        name = "abuse_flag_thread" if self.verbose else "PATCH_thread"
        self.patch_thread(
            thread_id=self._get_thread_id(),
            data=data,
            name=name,
        )
        self.wait_then_stop()

    @task(47)
    def vote_on_thread(self):
        """
        Vote on a thread

        Calls made:
        GET_thread_list
        PATCH_thread
        """
        data = {"voted": random.choice(["true", "false"])}
        name = "vote_on_thread" if self.verbose else "PATCH_thread"
        self.patch_thread(
            thread_id=self._get_thread_id(),
            data=data,
            name=name,

        )
        self.wait_then_stop()


class PatchCommentsTask(DiscussionsApiTasks):
    """
    Task for PATCH requests for comments

    /api/discussion/v1/comments/{comment_id}

    A response can only be edited, flagged, and voted on.
    A comment can only be edited and flagged.
    """

    def _get_comment_id(self):
        """
        Returns the id of a random comment from a random thread (of a random
        page).

        """
        page_size = random.choice(dapi_constants.PAGE_SIZE)
        thread = self.get_random_thread(page_size=page_size, prioritize_comments=True)
        self.wait()
        if not thread:
            self.stop()
        comment = self.get_random_comment(thread=thread)
        self.wait()
        if not comment:
            self.stop()
        return comment["id"]

    @task(30)
    def edit_comment(self):
        """
        Edit a comments's raw_body

        Calls made:
        GET_thread_list
        GET_comment_list
        PATCH_comment
        """
        new_body_size = random.choice(dapi_constants.BODY.keys())
        data = {"raw_body": dapi_constants.BODY[new_body_size]}
        name = "edit_comment_with_{}".format(new_body_size) if self.verbose else "PATCH_comment"
        self.patch_comment(
            comment_id=self._get_comment_id(),
            data=data,
            name=name
        )
        self.wait_then_stop()

    @task(50)
    def vote_on_comment(self):
        """
        Vote on a comment_response

        Calls made:
        GET_thread_list
        GET_comment_list
        PATCH_comment
        """
        data = {"voted": random.choice(["true", "false"])}
        name = "vote_on_comment" if self.verbose else "PATCH_comment"
        self.patch_comment(
            comment_id=self._get_comment_id(),
            data=data,
            name=name
        )
        self.wait_then_stop()

    @task(4)
    def abuse_flag_comment(self):
        """
        Flag a thread with

        Calls made:
        GET_thread_list
        GET_comment_list
        PATCH_comment
        """
        data = {"abuse_flagged": random.choice(["true", "false"])}
        name = "abuse_flag_comment" if self.verbose else "PATCH_comment"
        self.patch_comment(
            comment_id=self._get_comment_id(),
            data=data,
            name=name
        )
        self.wait_then_stop()


class PostThreadsTask(DiscussionsApiTasks):
    """
    Task for POSTing thread

    /api/discussion/v1/threads
    """

    @task
    def create_thread(self):
        """
        POST a thread

        Calls made:
        POST_thread
        """
        self.post_thread()
        self.wait_then_stop()


class PostCommentsTask(DiscussionsApiTasks):
    """
    Task for POSTing comments

    /api/discussion/v1/comments
    """

    @task(2)
    def post_response(self):
        """
        POST a response (1st level comment) and adds the id to the response list

        Calls made:
        GET_thread_list
        POST_comment_response
        """
        page_size = random.choice(dapi_constants.PAGE_SIZE)
        thread = self.get_random_thread(page_size=page_size)
        self.wait()
        if not thread:
            self.stop()
        self.create_response(thread_id=thread["id"])
        self.wait_then_stop()

    @task(1)
    def post_comment(self):
        """
        POST a comment (2nd level comment) to the response list

        Calls made:
        GET_thread_list
        POST_comment_response
        POST_comment_comment
        """
        page_size = random.choice(dapi_constants.PAGE_SIZE)
        thread = self.get_random_thread(page_size=page_size)
        self.wait()
        if not thread:
            self.stop()
        response = self.create_response(thread_id=thread["id"])
        self.wait()
        if not response:
            self.stop()
        self.create_comment(comment_id=response["id"], thread_id=response["thread_id"])
        self.wait_then_stop()


class DeleteThreadsTask(DiscussionsApiTasks):
    """
    Tasks for DELETE thread

    /api/discussion/v1/threads/{thread_id}
    """

    @task
    def delete_thread(self):
        """
        DELETE a thread

        A thread will be created with POST and then DELETED.

        Calls made:
        POST_thread
        DELETE_thread
        """
        thread = self.post_thread()
        self.wait()
        if not thread:
            self.stop()
        self.delete_course_thread(thread["id"])
        self.wait_then_stop()


class DeleteCommentsTask(DiscussionsApiTasks):
    """
    DELETEs a comment from a list of responses/comments

    /api/discussion/v1/comments/{comment_id}
    """

    @task
    def delete_response(self):
        """
        DELETE a response

        A response will be created with POST for randomly selected thread
        and then DELETED.

        Calls made:
        GET_thread_list
        POST_response
        DELETE_response
        """
        thread = self.get_random_thread(page=1, page_size=10)
        self.wait()
        if not thread:
            self.stop()
        response = self.create_response(thread_id=thread["id"])
        self.wait()
        if not response:
            self.stop()
        self.delete_comment(comment_id=response["id"])
        self.wait_then_stop()

    @task
    def delete_response_comment(self):
        """
        DELETE a response

        Retrieve threads to retrieve a response. Create a comment and then
        delete the comment.

        Calls made:
        GET_thread_list
        GET_response_list
        POST_response_comment
        DELETE_response_comment
        """
        thread = self.get_random_thread(page=1, page_size=10)
        self.wait()
        if not thread:
            self.stop()
        response = self.get_random_comment(thread=thread)
        self.wait()
        if not response:
            self.stop()
        new_comment = self.create_comment(comment_id=response["id"], thread_id=thread["id"])
        self.wait()
        if not new_comment:
            self.stop()
        self.delete_comment(comment_id=new_comment["id"])
        self.wait_then_stop()
This file holds the different tasks used for the Discussion API tests Task for GETting a single thread GET a thread          /api/discussion/v1/threads/{thread_id}          Calls made:         GET_thread GET a thread list          /api/discussion/v1/threads/?course_id={}...          Calls made:         GET_thread_list Task for GETting a thread list and reporting it's comment_count GET a thread and then report it's comment_count          /api/discussion/v1/threads/?course_id={}...          Calls made:         GET_thread_list         GET_thread Tasks for GETting comments GET the comment_list          /api/discussion/v1/comments/?thread_id={}...          Calls made:         GET_thread_list         GET_comment_list Returns the comment_count and response_count for a Thread          This helper method is used when requiring verbose outputs for threads         that have high comment_counts. For example, a response with         1000 comment.          Calls made:         GET_thread          Args:             thread_id (str): Thread to get the comment_count and response_count          Returns:             (tuple): (comment_count, response_count) Task for PATCH requests for threads      /api/discussion/v1/threads/{thread_id}      EditThread uses the staff role to edit while student roles vote, flag,     and follow. Returns the id of a random thread. Edit a thread's raw_body          Calls made:         GET_thread_list         PATCH_thread Follow a thread          Calls made:         GET_thread_list         PATCH_thread Flag a thread with          Calls made:         GET_thread_list         PATCH_thread Vote on a thread          Calls made:         GET_thread_list         PATCH_thread Task for PATCH requests for comments      /api/discussion/v1/comments/{comment_id}      A response can only be edited, flagged, and voted on.     A comment can only be edited and flagged. Returns the id of a random comment from a random thread (of a random         page). Edit a comments's raw_body          Calls made:         GET_thread_list         GET_comment_list         PATCH_comment Vote on a comment_response          Calls made:         GET_thread_list         GET_comment_list         PATCH_comment Flag a thread with          Calls made:         GET_thread_list         GET_comment_list         PATCH_comment Task for POSTing thread      /api/discussion/v1/threads POST a thread          Calls made:         POST_thread Task for POSTing comments      /api/discussion/v1/comments POST a response (1st level comment) and adds the id to the response list          Calls made:         GET_thread_list         POST_comment_response POST a comment (2nd level comment) to the response list          Calls made:         GET_thread_list         POST_comment_response         POST_comment_comment Tasks for DELETE thread      /api/discussion/v1/threads/{thread_id} DELETE a thread          A thread will be created with POST and then DELETED.          Calls made:         POST_thread         DELETE_thread DELETEs a comment from a list of responses/comments      /api/discussion/v1/comments/{comment_id} DELETE a response          A response will be created with POST for randomly selected thread         and then DELETED.          Calls made:         GET_thread_list         POST_response         DELETE_response DELETE a response          Retrieve threads to retrieve a response. Create a comment and then         delete the comment.          Calls made:         GET_thread_list         GET_response_list         POST_response_comment         DELETE_response_comment