behat / webapiextension Goto Github PK

I'm testing an API that I just moved to https, and since I'm using a self-signed-certificate, guzzle gives me errors. Maybe the verify option should be set to false by default, and maybe it should even be configurable (not sure why though).

Here is how I worked around this problem.

Would you please consider tagging a stable release ?
Is there anything preventing it ?

https://github.com/Behat/WebApiExtension/blob/master/doc/index.rst#usage :-)

Have you plan a date for it?

Thanks.

Due to the requirements, one cannot use guzzle 5 and the web api extension on the same project. Solution : suggest instead of require guzzle, then detect the guzzle version in use ?

It's all private. How should I use it ?

Hi,

Is it possible to use php-http/httplug instead of guzzle.
This allow users to use the php-http/mock-client as client and perform nice tests.

$config['bar_url'] should be $config['base_url']

The following method:

    public function iSendARequestWithValues($method, $url, TableNode $post)
    {
        $url = $this->prepareUrl($url);
        $fields = array();

        foreach ($post->getRowsHash() as $key => $val) {
            $fields[$key] = $this->replacePlaceHolder($val);
        }

        $bodyOption = array(
          'body' => json_encode($fields),
        );
        $this->request = $this->client->createRequest($method, $url, $bodyOption);
        if (!empty($this->headers)) {
            $this->request->addHeaders($this->headers);
        }

        $this->sendRequest();
    }

Does not work, when the $fields is json encoded. When removing that line, it works perfectly. I.e, like this:

    public function iSendARequestWithValues($method, $url, TableNode $post)
    {
        $url = $this->prepareUrl($url);
        $fields = array();

        foreach ($post->getRowsHash() as $key => $val) {
            $fields[$key] = $this->replacePlaceHolder($val);
        }

        $bodyOption = array(
          'body' => $fields,
        );
        $this->request = $this->client->createRequest($method, $url, $bodyOption);
        if (!empty($this->headers)) {
            $this->request->addHeaders($this->headers);
        }

        $this->sendRequest();
    }

Now, before I submit a pull request, I want to make sure I am not getting something wrong? The bug seems too obvious.

I am testing with this data:

        When I send a POST request to "/items" with values:
            | attributes    | {"size":"1", "size_length":5} |
            | category      | 1      |

This has been raised before (#8), but I would like to see it revisited. PHPUnit assertions are currently used, but this involves pulling 17 (I think) other packages for just 6 assertions. We're not using PHPUnit in a project, so this is dramatically increasing the number of dependencies.

As PHPUnit doesn't provide its assertions in a standalone library, I think something else should be used, or they could just be replaced with internal ones (less convenient, but there's not that many).

Since $response has been set to private and $headers is currently only used for request headers, contexts inheriting WebApiContext have no way to access the response headers.

Suggested change:

• either mark $response as protected instead of private
• or add $this->headers = $this->response->getHeaders(); at the end of sendRequest(), making headers usable for both request and response
• or provide separate properties+accessors for request and response headers.

I've being using this repo for a long time but, there is no activity and lot of PR pending.
If there is no plan to maintain this repo?
Why not ask for maintainers if there is no time for the actuals?

It's a cool tool, and I don't wanna lose it.

Thanks in advance

I'm using the And the response should contain json: step, this is working when I check a json body with { "foo": "bar" }
But when my body is a jsonArray like this[{ "foo": "bar", "bar": "foo" }] I must send all the correct datas of the first element of the jsonArray to have this step valid. This is problematic when you have a DataTime that change at every data fixtures loading...

I tried to made a custom step in my FeatureContext who will check if there is a jsonArray or not and make the good value check but I need to get the returned response of the request who's not accessible the response in WebApiExtension

Is it possible to check only one value in the first element of a jsonArray with WebApiContext or I must make a custom step ?
If I must made a custom step how can I have access to the request response in my FeatureContext ?

This the type of scenario I'm trying to test and making work :

 Scenario: I find all my DNS zones as customer
   Given I am authenticated as customer
   And I send a GET request to "/api/dns"
   Then the response code should be 200
   And the response should contain json:
   """
   [{
     "name":"club-internet.fr"
   }]
   """

┌─ @BeforeScenario # FeatureContext::prepareScenario()
│
╳ Notice: A non well formed numeric value encountered in features/bootstrap/FeatureContext.php line 47

Hi!

The Web API Extension is exactly what I was looking for and has been a huge help. When I tried to use iSendARequestWithFormData, however, I found that it was losing any headers I had already added.

I wanted to suggest something like the following at line 198:

        $this->addHeader('Content-Type', 'application/x-www-form-urlencoded');
        $this->request = new Request($method, $url, $this->headers, http_build_query($fields, null, '&'));

Is that reasonable? Many apologies if I'm missing something.

There are 27 Pull requests on hold, and several forks with improvements waiting to be pulled. Please add some collaborators so we can keep up the good work. Let's give it some life again.
@stof

If I want to extend that context I need raw access to the request and response object.

@jakzal started https://github.com/jakzal/RestExtension for a similar purpose. The interesting parts of the extension should be merged here.

I'm thinking in particular to the response matcher, which is something I wanted to implement in WebApiExtension. The library used in the RestExtension seems to fit very well with what I have in mind.

@stof
I've upgraded my fork of this project to Guzzle version 6.
Would you be interested in merging this if I made a PR to this project?

https://github.com/nspyke/WebApiExtension/tree/1.1.1

Hello, I have a problem the following feature:

  Scenario Outline: The POST Code response (Entity)
    Given I set header "Accept" with value "application/json"
    And  I set header "Content-Type" with value "application/json"
    When I send a POST request to "/api/users" with body:
    """
      <json>
    """
    Then the response code should be 201

    Examples:
      | json                                             |
      | {"first_name" : "Leigh", "last_name" : "Oros"}   |
      | {"first_name" : "Hope", "last_name" : "Perron"}  |
      | {"first_name" : "Allena", "last_name" : "Spece"} |

The test is correct for the first user (Leigh Oros), but the API throws an error for Hope Perron and Allena Speece. After introspecting the http request I detected that the error is triggered by the Accept and Content-Type headers.

For the first users the headers are:

Array
(
    [Host] => localhost
    [Accept] => application/json
    [Content-Type] => application/json
    [User-Agent] => Guzzle/5.3.0 curl/7.38.0 PHP/5.6.15
    [Content-Length] => 205
)

Until now API works correctly and everything is ok.

However, the request for the second user have the following headers

Array
(
    [Host] => localhost
    [Accept] => application/json, application/json
    [Content-Type] => application/json, application/json
    [User-Agent] => Guzzle/5.3.0 curl/7.38.0 PHP/5.6.15
    [Content-Length] => 205
)

And for third user:

Array
(
    [Host] => localhost
    [Accept] => application/json, application/json, application/json
    [Content-Type] => application/json, application/json, application/json
    [User-Agent] => Guzzle/5.3.0 curl/7.38.0 PHP/5.6.15
    [Content-Length] => 205
)

For second and third request, the answer from the API is:

{
  "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
  "title":"Unsupported Media Type",
  "status":415,"detail":"Invalid content-type specified"
}

Cleary the headers are append to the existing ones, even if the value is the same. I was expecting that header would be reset for each Example, but is not the case.

Also I don't think that separating multiple mime times with commas are valid Accept and Content-Type headers.

For instance I have solved the issue checking if the header value is already present before adding it 9c602da however I'm not shure who's responsability is to check the validity of headers (WebApiExtension, Gizzle, Behat??). If the solution seems correct I want to make a pull request.

Any feedback will be appreciated.

Hi,

I have the following error when I run tests of this extension.

      │ --- Failed steps:
      │ 
      │     And the response should contain json: # features/send_raw.feature:16
      │       Can not convert actual to json:
      │       <br />
      │       <b>Deprecated</b>:  Automatically populating $HTTP_RAW_POST_DATA is deprecated and will be removed in a future version. To avoid this warning set 'always_populate_raw_post_data' to '-1' in php.ini and use the php://input stream instead. in <b>Unknown</b> on line <b>0</b><br />
      │       <br />
      │       <b>Warning</b>:  Cannot modify header information - headers already sent in <b>Unknown</b> on line <b>0</b><br />
      │       {"warning":"Do not expose this service in production : it is intrinsically unsafe","method":"POST","name":"name","pass":"pass","headers":{"user-agent":["GuzzleHttp\/6.2.1 curl\/7.22.0 PHP\/5.6.5"],"host":["localhost:8080"],"content-type":["application\/json"],"content-length":["35"],"x-php-ob-level":[1]},"query":[]} (Assert\InvalidArgumentException)

https://github.com/Behat/WebApiExtension/blob/master/doc/index.rst

It should be:

default:
    extensions:
        Behat\WebApiExtension\ServiceContainer\WebApiExtension: ~

Behat config:

default:
    calls:
        error_reporting: 14335 # E_ALL & ~E_USER_DEPRECATED
    extensions:
        Behat\Symfony2Extension: ~
        Behat\WebApiExtension: ~
        Behat\MinkExtension:
            sessions:
                default:
                    symfony2: ~
    suites:
        default:
            contexts:
             - Behat\WebApiExtension\Context\WebApiContext
             - \FeatureContext

Behat feature:

Feature: api/security
  In order to fully or partially access the api
  I need to have the good rights

  Scenario: API as anonymous
    Given I am on "/api/user"
    And the response status code should be 401
    And the response should contain json:
    """
    {
       "error" : "invalid_grant",
       "error_description" : "No API key given."
    }
    """

Result:

$ behat features/api/security.feature 
Feature: api/security
  In order to fully or partially access the api
  I need to have the good rights

  Scenario: API as anonymous                   # features/api/security.feature:5
    Given I am on "/api/user"                  # FeatureContext::visit()
    And the response status code should be 401 # FeatureContext::assertResponseStatus()
PHP Fatal error:  Call to a member function json() on null in project/vendor/behat/web-api-extension/src/Context/WebApiContext.php on line 244
[...]

Is that an issue or a misconfiguration?

Thanks.