tester

README

Compact denylist format blocker validator

This module provides a test suite checks that the rules present in test.deny are correctly understood and processed by a Blocker implementation.

Documentation

Overview

Package tester provides an implementation-agnostic way to test a Blocker.

Index

• type Blocker
• type Header
• type Suite
  • func (s *Suite) Run(b Blocker) error

Types

type Blocker

type Blocker interface {
	ReadHeader(r io.Reader) (Header, error)
	ReadDenylist(r io.ReadSeekCloser) error
	IsPathBlocked(p path.Path) bool
	IsCidBlocked(c cid.Cid) bool
}

Blocker defines the minimal interface that a blocker should support to be tested.

type Header

type Header interface {
	Name() string
	Hints() map[string]string
}

Header represents a denylist header.

type Suite

type Suite struct {
	TestHeader           bool
	TestCID              bool
	TestCIDPath          bool
	TestIPNSPath         bool
	TestDoubleHashLegacy bool
	TestDoubleHash       bool
	// contains filtered or unexported fields
}

Suite repesents the test suite and different test types can be enabled/disabled to match what the Blocker implementation supports.

func (*Suite) Run

func (s *Suite) Run(b Blocker) error

Run performs blocker-validation tests based on test.deny using the given blocker. Only the enabled tests in the suite are performed.