https://github.com/pulyaevskiy/dart-http-mocks

Mocks for dart:io HTTP requests
https://github.com/pulyaevskiy/dart-http-mocks

Last synced: 3 months ago
JSON representation

Mocks for dart:io HTTP requests

• Host: GitHub
• URL: https://github.com/pulyaevskiy/dart-http-mocks
• Owner: pulyaevskiy
• License: bsd-2-clause
• Created: 2016-01-21T19:05:10.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-03-28T21:58:08.000Z (about 9 years ago)
• Last Synced: 2025-01-07T16:44:17.046Z (5 months ago)
• Language: Dart
• Size: 18.6 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Mocks for dart:io HTTP requests

[![Build Status](https://img.shields.io/travis-ci/pulyaevskiy/dart-http-mocks.svg?branch=master&style=flat-square)](https://travis-ci.org/pulyaevskiy/dart-http-mocks)

[![Coverage Status](https://img.shields.io/coveralls/pulyaevskiy/dart-http-mocks.svg?branch=master&style=flat-square)](https://coveralls.io/github/pulyaevskiy/dart-http-mocks?branch=master)

[![License](https://img.shields.io/badge/license-BSD--2-blue.svg?style=flat-square)](https://raw.githubusercontent.com/pulyaevskiy/dart-http-mocks/master/LICENSE)

Mocks and special test matchers to simplify testing of HttpRequests

from `dart:io`.

## 1. Usage

```dart

// file: some_test.dart

library some_lib.tests;

import 'dart:io';

import 'package:test/test.dart';

import 'package:http_mocks/http_mocks.dart';

void main() {

  test('it mocks http requests', () async {

    var request = new HttpRequestMock(Uri.parse('/hello-world'), 'GET');

    // Pass it to your HTTP server or whatever else accepting HttpRequest

    // as an input argument:

    await yourHttpServer.handle(request);

    // Use provided matchers:

    expect(request, responseStatus(HttpStatus.OK));

    expect(request, responseContentType(ContentType.TEXT));

    expect(request,

      responseHeaders(containsPair('Access-Control-Allow-Origin', '*')));

    expect(request, responseBody(contains('Hello world!')));

    expect(request, responseSent); // makes sure request has been "closed".

  });

}

```

## 2. How it works

Under the hood this library uses

[mockito](https://pub.dartlang.org/packages/mockito) to create all the mocks.

All mocks are available through `HttpRequestMock` so it is possible

to perform custom expectations or verifications provided by `mockito`

library.

```dart

var request = new HttpRequestMock(Uri.parse('/foo'), 'GET');

request.headersMock; // mock for request's headers

request.responseMock; // mock for HttpResponse

request.responseHeadersMock; // mock for response's headers

```

## 3. Limitations

Current implementation only covers only a subset of all possible use cases,

though hopefully the most common ones. This means that not all the expectations

can be performed.

* The `HttpHeadersMock` does not support "multi-value" headers at

  this moment (but this can be added in the future).

* Reading of request body assumes you will use `UTF8.decodeStream()`.

If you find a use case which is not covered, feel free to create an issue or a

pull request!

## License

BSD-2