wilderbeest

assert-headers

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

- assert-headers CLI command for asserting a response against a header schema

- default export is an assertHeaders function for asserting a headers object against a schema

- exports a named fromUrl method which makes an HTTP(S) request and asserts the response headers against a configuration

    "assert-headers": "bin/assert-headers/index.js"

    "url": "git+https://github.com/djragsdale/assert-headers-node.git"

  "author": "David Ragsdale <https://github.com/djragsdale>",

    "url": "https://github.com/djragsdale/assert-headers-node/issues"

  "homepage": "https://github.com/djragsdale/assert-headers-node#readme",

# Assume headersSchema.json in current working directory

assert-headers --config ./customConfiguration.json https://example.com

npx assert-headers --silent --config ./customConfiguration.json https://example.com

TODO: Add example of how to stream a column of a .csv into the tool

TODO: Show how the exit codes can be used in smoke tests

`assert-headers` currently accepts configuration in JSON format. It allows specifying a schema for the headers, but also the outgoing origin and user-agent headers for the request. Below is an example configuration:

1. `"disallowed-header-name": false` - It is considered an error if this header is defined

1. `"required-header-name": true` - It is considered an error if this header is missing (or `undefined`)

1. `"strict-header-name": "only good value"` - It is considered an error if this header does not have this value

1. `"enumerated-header-name": { "good header value": true, "another good value": true }` - It is considered an error if this header contains a value other than one marked `true`.

1. `"enumerated-header-name": { "bad header value": false, "another bad value": false }` - It is considered an error if this header contains a value not marked `true`

1. If no enumerated header values are marked `true`, all listed values are considered invalid values. It is highly recommended to ONLY use `true` and `false` for enumerated values

const assertHeader = require('assert-header')

  'strict-transport-security': 'max-age=31536000; includeSubDomains',

    // if any are true, the header value must match a true schema value

    err.errors.forEach((assertionError) => {

      console.error(`The header ${assertionError.headerName} was bad!`)

This can also be used inside a test library for validating HTTP response headers.

    'user-agent': 'Custom User Agent name',

    'userAgent': 'Custom User Agent name',

      'x-content-type-options': 'nosniff',

        // if any are true, the header value must match a true schema value

  await assertHeader.fromUrl('https://example.com/my-test-page', configuration)

		@@ -9,2 +9,8 @@ # Changelog

		## [0.1.2] - 2021-05-20

		### Fixed

		- Configuration property for user-agent

		## [0.1.1] - 2021-05-07
		@@ -11,0 +17,0 @@

		{
		"user-agent": "assert-headers-node",
		"userAgent": "assert-headers-node",
		"origin": "https://example.com",
		@@ -4,0 +4,0 @@ "schema": {

		{
		"name": "assert-headers",
		"version": "0.1.1",
		"version": "0.1.2",
		"description": "Assert HTTP headers",
		@@ -5,0 +5,0 @@ "main": "lib/index.js",

		@@ -53,3 +53,3 @@ # assert-headers-node
		{
		"user-agent": "assert-headers-node",
		"userAgent": "assert-headers-node",
		"origin": "https://example.com",
		@@ -120,3 +120,3 @@ "schema": {
		const configuration {
		'user-agent': 'Custom User Agent name',
		'userAgent': 'Custom User Agent name',
		origin: 'https://my-domain.com',
		@@ -123,0 +123,0 @@ schema: {

Improved metrics