steps.api.given_cloud
=====================

.. py:module:: steps.api.given_cloud


Functions
---------

.. autoapisummary::

   steps.api.given_cloud.prepare_cloud_request
   steps.api.given_cloud.log_as_user
   steps.api.given_cloud.log_as_admin
   steps.api.given_cloud.get_user
   steps.api.given_cloud.create_job_token
   steps.api.given_cloud.delete_platform
   steps.api.given_cloud.register_platform_simplify
   steps.api.given_cloud.get_platform
   steps.api.given_cloud.register_platform
   steps.api.given_cloud.fetch_platform_job
   steps.api.given_cloud.run_platform_job
   steps.api.given_cloud.progress_job
   steps.api.given_cloud.finish_job
   steps.api.given_cloud.assign_user_to_platform
   steps.api.given_cloud.assign_token_to_platform
   steps.api.given_cloud.assign_user_and_token_to_platform
   steps.api.given_cloud.create_job_simplified
   steps.api.given_cloud.create_job
   steps.api.given_cloud.create_job_payload
   steps.api.given_cloud.get_job_status
   steps.api.given_cloud.get_job_result
   steps.api.given_cloud.get_job_info
   steps.api.given_cloud.cancel_job
   steps.api.given_cloud.step_impl


Module Contents
---------------

.. py:function:: prepare_cloud_request(context)

   Prepare a new request for the cloud API.

   Shorthand for creating a request to the cloud API type.

   :param context: The Behave context


.. py:function:: log_as_user(context: steps.api.utils.Context, user_index: str) -> None

   Log in as a specific test user.

   :param context: The Behave context
   :param user_index: Index of the user in the users list


.. py:function:: log_as_admin(context: steps.api.utils.Context) -> None

   Log in as the admin user.

   :param context: The Behave context


.. py:function:: get_user(context: steps.api.utils.Context, user_index: str)

   Get information about a specific user.

   :param context: The Behave context
   :param user_index: Index of the user in the users list
   :return: User data from the response


.. py:function:: create_job_token(context: steps.api.utils.Context, token_label: str, user_index: str) -> None

   Create a new job token for a specific user.

   :param context: The Behave context
   :param token_label: Label for the new token
   :param user_index: Index of the user to create the token for


.. py:function:: delete_platform(context: steps.api.utils.Context, platform_id_method: str) -> None

   Delete a platform by its ID.

   :param context: The Behave context
   :param platform_id_method: Method to get the platform ID


.. py:function:: register_platform_simplify(context: steps.api.utils.Context, platform_name_method) -> None

.. py:function:: get_platform(context: steps.api.utils.Context, platform_name_or_id_method: str) -> steps.api.cloud.Platform

.. py:function:: register_platform(context: steps.api.utils.Context) -> None

.. py:function:: fetch_platform_job(context: steps.api.utils.Context, platform_name_method: dict = None) -> None

.. py:function:: run_platform_job(context: steps.api.utils.Context, job_id_method: dict = None) -> None

.. py:function:: progress_job(context: steps.api.utils.Context, job_id_method: dict = None) -> None

.. py:function:: finish_job(context: steps.api.utils.Context, job_id_method: dict = None) -> None

.. py:function:: assign_user_to_platform(context: steps.api.utils.Context, user_index: str, platform_id_method: str)

.. py:function:: assign_token_to_platform(context: steps.api.utils.Context, job_token_id_method: str, platform_id_method: str) -> None

.. py:function:: assign_user_and_token_to_platform(context: steps.api.utils.Context, user_index: str, platform_name_method: str)

.. py:function:: create_job_simplified(context: steps.api.utils.Context, user_index: str)

.. py:function:: create_job(context: steps.api.utils.Context, user_index: str, platform_name_method: str) -> None

.. py:function:: create_job_payload(context: steps.api.utils.Context, user_index: str) -> None

.. py:function:: get_job_status(context: steps.api.utils.Context, job_id_method: str, user_index: str) -> None

.. py:function:: get_job_result(context: steps.api.utils.Context, job_id_method: str, user_index: str) -> None

.. py:function:: get_job_info(context: steps.api.utils.Context, job_id_method: str) -> None

.. py:function:: cancel_job(context: steps.api.utils.Context, job_id_method: str, user_index: str) -> None

.. py:function:: step_impl(context, state)