Skip to content

Latest commit

 

History

History
333 lines (210 loc) · 7.42 KB

Queue.md

File metadata and controls

333 lines (210 loc) · 7.42 KB
layout title
doc
Queue - Codeception - Documentation

Queue

Installation

{% highlight yaml %} composer require --dev codeception/module-queue

{% endhighlight %}

Description

Works with Queue servers.

Testing with a selection of remote/local queueing services, including Amazon's SQS service Iron.io service and beanstalkd service.

Supported and tested queue types are:

The following dependencies are needed for the listed queue servers:

  • Beanstalkd: pda/pheanstalk ~3.0
  • Amazon SQS: aws/aws-sdk-php
  • IronMQ: iron-io/iron_mq

Status

  • Stability:
    • Iron.io: stable
    • Beanstalkd: stable
    • Amazon SQS: stable

Config

The configuration settings depending on which queueing service is being used, all the options are listed here. Refer to the configuration examples below to identify the configuration options required for your chosen service.

  • type - type of queueing server (defaults to beanstalkd).

  • host - hostname/ip address of the queue server or the host for the iron.io when using iron.io service.

  • port: 11300 - port number for the queue server.

  • timeout: 90 - timeout settings for connecting the queue server.

  • token - Iron.io access token.

  • project - Iron.io project ID.

  • key - AWS access key ID.

  • version - AWS version (e.g. latest)

  • endpoint - The full URI of the webservice. This is only required when connecting to a custom endpoint (e.g., a local version of SQS).

  • secret - AWS secret access key. Warning: Hard-coding your credentials can be dangerous, because it is easy to accidentally commit your credentials into an SCM repository, potentially exposing your credentials to more people than intended. It can also make it difficult to rotate credentials in the future.

  • profile - AWS credential profile - it should be located in ~/.aws/credentials file - eg: [default] aws_access_key_id = YOUR_AWS_ACCESS_KEY_ID aws_secret_access_key = YOUR_AWS_SECRET_ACCESS_KEY [project1] aws_access_key_id = YOUR_AWS_ACCESS_KEY_ID aws_secret_access_key = YOUR_AWS_SECRET_ACCESS_KEY - Note: Using IAM roles is the preferred technique for providing credentials to applications running on Amazon EC2 https://docs.aws.amazon.com/sdk-for-php/v3/developer-guide/guide_credentials.html?highlight=credentials

  • region - A region parameter is also required for AWS, refer to the AWS documentation for possible values list.

Example

Example (beanstalkd)
modules:
   enabled: [Queue]
   config:
      Queue:
         type: 'beanstalkd'
         host: '127.0.0.1'
         port: 11300
         timeout: 120
Example (Iron.io)
modules:
   enabled: [Queue]
   config:
      Queue:
         'type': 'iron',
         'host': 'mq-aws-us-east-1.iron.io',
         'token': 'your-token',
         'project': 'your-project-id'
Example (AWS SQS)
modules:
   enabled: [Queue]
   config:
      Queue:
         'type': 'aws',
         'key': 'your-public-key',
         'secret': 'your-secret-key',
         'region': 'us-west-2'
Example AWS SQS using profile credentials
modules:
   enabled: [Queue]
   config:
      Queue:
         'type': 'aws',
         'profile': 'project1', //see documentation
         'region': 'us-west-2'
Example AWS SQS running on Amazon EC2 instance
modules:
   enabled: [Queue]
   config:
      Queue:
         'type': 'aws',
         'region': 'us-west-2'

Actions

addMessageToQueue

  • param string $message Message Body
  • param string $queue Queue name
  • return void

Add a message to a queue/tube

{% highlight php %}

addMessageToQueue('this is a messages', 'default'); {% endhighlight %} #### clearQueue * `param string` $queue Queue name * `return void` Clear all messages of the queue/tube {% highlight php %} clearQueue('default'); {% endhighlight %} #### dontSeeEmptyQueue * `param string` $queue Queue name * `return void` Check if a queue/tube is NOT empty of all messages {% highlight php %} dontSeeEmptyQueue('default'); {% endhighlight %} #### dontSeeQueueExists * `param string` $queue Queue name * `return void` Check if a queue/tube does NOT exist on the queueing server. {% highlight php %} dontSeeQueueExists('default'); {% endhighlight %} #### dontSeeQueueHasCurrentCount * `param string` $queue Queue name * `param int` $expected Number of messages expected * `return void` Check if a queue/tube does NOT have a given current number of messages {% highlight php %} dontSeeQueueHasCurrentCount('default', 10); {% endhighlight %} #### dontSeeQueueHasTotalCount * `param string` $queue Queue name * `param int` $expected Number of messages expected * `return void` Check if a queue/tube does NOT have a given total number of messages {% highlight php %} dontSeeQueueHasTotalCount('default', 10); {% endhighlight %} #### grabQueueCurrentCount * `param string` $queue Queue name * `return int` Count Grabber method to get the current number of messages on the queue/tube (pending/ready) {% highlight php %} grabQueueCurrentCount('default'); {% endhighlight %} #### grabQueueTotalCount * `param string` $queue Queue name * `return int` Count Grabber method to get the total number of messages on the queue/tube {% highlight php %} grabQueueTotalCount('default'); {% endhighlight %} #### grabQueues * `return string[]` List of Queues/Tubes Grabber method to get the list of queues/tubes on the server {% highlight php %} grabQueues(); {% endhighlight %} #### seeEmptyQueue * `param string` $queue Queue name * `return void` Check if a queue/tube is empty of all messages {% highlight php %} seeEmptyQueue('default'); {% endhighlight %} #### seeQueueExists * `param string` $queue Queue name * `return void` Check if a queue/tube exists on the queueing server. {% highlight php %} seeQueueExists('default'); {% endhighlight %} #### seeQueueHasCurrentCount * `param string` $queue Queue name * `param int` $expected Number of messages expected * `return void` Check if a queue/tube has a given current number of messages {% highlight php %} seeQueueHasCurrentCount('default', 10); {% endhighlight %} #### seeQueueHasTotalCount * `param string` $queue Queue name * `param int` $expected Number of messages expected * `return void` Check if a queue/tube has a given total number of messages {% highlight php %} seeQueueHasTotalCount('default', 10); {% endhighlight %}

 

Module reference is taken from the source code. Help us to improve documentation. Edit module reference