Skip to content

README.md

Latest commit

 

History

History
87 lines (67 loc) · 5.14 KB

README.md

File metadata and controls

87 lines (67 loc) · 5.14 KB
Raw

AngleSharp.TestSite

The webpage to run reliable online integration tests against.

This is the site exercised by the AngleSharp integration tests (e.g. the FormSubmitTests and ContextLoading fixtures in AngleSharp.Core). It exposes a handful of endpoints that echo requests, validate form submissions, stream a chunked response, and serve a page with (deliberately partly-broken) resources.

Originally an ASP.NET MVC application, it has been ported to a Node.js Fastify app written in TypeScript. The behavior — the HTML produced and the way requests are validated — is preserved. The original sources are kept for reference under legacy/.

Getting started

npm install
npm run dev      # start with live reload on http://localhost:8080

For a production-style run:

npm run build    # compile TypeScript into dist/
npm start        # run the compiled server

The listen port and host can be overridden with the PORT (default 8080) and HOST (default 0.0.0.0) environment variables.

Endpoints

Route Method Purpose
/ GET Overview page linking to every GET test page.
/PostUrlencodeNormal GET/POST application/x-www-form-urlencoded form; POST validates Name/Number/IsActive.
/PostUrlencodeFile GET/POST Urlencoded form with a file field; POST checks the submitted file name.
/PostMultipartNormal GET/POST multipart/form-data form; POST validates the fields.
/PostMultipartFile GET/POST Multipart form; POST validates one uploaded file's name, type, and bytes.
/PostMultipartFiles GET/POST Multipart form; POST validates five uploaded files.
/PostAnything GET/POST Echoes any posted key/value pairs into the page.
/Echo POST Renders a table of the parsed form fields plus the raw request body.
/Header/:id? GET Returns the value of the named request header (default referer).
/Chunked GET Streams an HTML document using chunked transfer encoding with delays.
/Page GET Resource-loading test page (references some missing resources on purpose).
/static/Css/:id GET Returns randomized text/css content.
/Content/* GET Static assets (style.css, jquery.js, 200w.gif).
/ws-echo WS WebSocket endpoint that echoes back every message it receives.

Routing is case-insensitive, matching the original ASP.NET behavior.

Test-case endpoints

These stand in for third-party sites that AngleSharp's integration tests used to depend on, so the tests no longer reach out to the public internet. The captured pages under public/test-cases/ are the real HTML of those sites at capture time.

Route Method Purpose
/test-cases/powerball GET Real Powerball home page, served gzip-encoded (replaces powerball.com).
/test-cases/empireaerials GET Real Empire Aerials page, served gzip-encoded (replaces empireaerials.net).
/test-cases/kommersant GET Large gzip-encoded page (replaces kommersant.ru/rss-list; guards against a buffer-too-small bug).
/test-cases/eurobelarus GET Gzip-encoded page (replaces eurobelarus.info; guards against a stuck stream).
/test-cases/europarl GET A valid HTML document (replaces the europarl.europa.eu PDF URL).
/test-cases/html GET Moby-Dick page (replaces httpbingo.org/html), served with a negotiated Content-Encoding (Brotli, Deflate, or gzip per Accept-Encoding).
/test-cases/status/:code GET Responds with the given status code (100–999).
/test-cases/methods/get GET 200 with an empty body for GET, otherwise 405.
/test-cases/methods/post POST 200 for POST with a body reflecting the request body, otherwise 405.
/test-cases/methods/put PUT 200 for PUT with a body reflecting the request body, otherwise 405.
/test-cases/methods/delete DELETE 200 with an empty body for DELETE, otherwise 405.
/test-cases/user-agent GET Reflects the User-Agent header as JSON.
/test-cases/robots GET Plain-text robots.txt (User-agent: * / Disallow: /deny).
/test-cases/set-cookies GET Sets a cookie per query parameter, then 302-redirects to get-cookies.
/test-cases/get-cookies GET Returns the request cookies as a JSON object.
/test-cases/redirect?url= GET 302-redirects to the URL in the url query parameter.

The user-agent and *-cookies endpoints mirror httpbingo's exact JSON formatting (Go's two-space, sorted-key indentation) so the responses are byte-for-byte compatible.

Docker

A multi-stage Dockerfile builds a small production image:

docker build -t anglesharp-testsite .
docker run --rm -p 8080:8080 anglesharp-testsite

Continuous delivery

The Build and publish Docker image GitHub Actions workflow type-checks and builds the app, then builds a Docker image and publishes it to the GitHub Container Registry (GHCR) as ghcr.io/anglesharp/anglesharp.infrastructure.testsite on pushes to main.