buoyantio / flossy Goto Github PK

View Code? Open in Web Editor NEW

7.0 10.0 0.0 76 KB

a tool for testing standard compliance of HTTP proxies

License: Apache License 2.0

Rust 100.00%

flossy's Introduction

flossy

A tool for automatic end-to-end black-box compliance testing of HTTP proxies.

Please note that flossy is under active development and may change drastically and without warning.

Quickstart

Install Rust and Cargo.
Start the proxy you want to test
From this repository, run: cargo run PROXY_URL:PROXY_PORT, where PROXY_URL and PROXY_PORT are the URL (or IP address) and port of the HTTP proxy under test.

We ❤️ pull requests! See CONTRIBUTING.md for info on contributing changes.

Usage

flossy 0.0.1
a tool for testing standard compliance of HTTP proxies

USAGE:
    main [FLAGS] <PROXY_URL> [PORT]

FLAGS:
    -h, --help       Prints help information
    -v               Sets the level of verbosity
    -V, --version    Prints version information

ARGS:
    <PROXY_URL>    URL of the proxy to test.
    <PORT>         Port used by flossy's test server.

Code of Conduct

This project is for everyone. We ask that our users and contributors take a few minutes to review our code of conduct.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use these files except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

flossy's People

Contributors

Stargazers

Watchers

flossy's Issues

UI improvements

rustc --explain-like functionality for failing tests?
~~make a pretty spinner while tests are in flight?~~
show failing responses ~~and highlight why they failed~~
highlight the parts of responses that are Wrong? (might need to add a diffing library)

Better failure reporting

flossy should find all problems in a test, not just the first one.
indicate clearly whether the failure was in the request forwarded to the flossy server, or in the response received by the flossy client
highlight the spans in the message that are erroneous? (this may require more serious parsing)

Client & server should collude over IPC

Currently, flossy's client and server thread communicate things like what messages to expect and whether or not the server received the expected messages using the HTTP requests/responses that are part of the test. This is kind of a hacky mess, and in the long run, especially when we start generating requests programmatically (#13), I'd really like this communication to happen through some form of IPC.

Verbosity command-line flag should actually...do something

Publish on crates.io

So you can just cargo install flossy.

Unfortunately, since crates published on crates.io can't depend on git dependencies, we either need to drop the dependency on my fork of tokio-minihttp, or wait for it to be merged (which may never happen since it's essentially a proof-of-concept lib)...

Switch to http

Now that http is released, there's no reason to continue usingtokio-minihttp. This will also fix a lot of issues we're having with tokio-minihttp, such as #11 (and the fact that it can't actually parse message bodies).

Tests for conflicting content length and chunked encoding headers

Conflicting Content-Length and Transfer-Encoding: chunked in request
Conflicting Content-Length and Transfer-Encoding: chunked in response

More comprehensive tests

Right now, each test only gets one corresponding request, and the requests are preset. It would be nice if we could attempt to treat these behaviors as properties, and generate several pathological requests/responses for each case. This would make flossy's proof of compliance more conclusive.