quixote package

Subpackages

• quixote.build package
  • Subpackages
    • quixote.build.apt package
      • Module contents
    • quixote.build.debconf package
      • Module contents
    • quixote.build.pip package
      • Module contents
    • quixote.build.shell package
      • Module contents
    • quixote.build.installs package
      • Module contents
  • Submodules
    • quixote.build.output module
    • quixote.build.utils module
  • Module contents
• quixote.fetch package
  • Subpackages
    • quixote.fetch.gitlab package
      • Module contents
  • Module contents
• quixote.inspection package
  • Subpackages
    • quixote.inspection.build package
      • Module contents
    • quixote.inspection.diff package
      • Module contents
    • quixote.inspection.exec package
      • Module contents
    • quixote.inspection.check package
      • Module contents
    • quixote.inspection.pushd package
      • Module contents
  • Module contents

Module contents

quixote.get_context() → Mapping[str, Any]

Retrieve the current build context

Returns

a mapping describing the current context

quixote.new_context(**kwargs: Any) → Mapping[str, Any]

Create a new context for the duration of a with-block

Parameters

kwargs – entries to initialize the context with

Returns

the context

class quixote.Builder(wrapped_function, **kwargs)

Class wrapping a builder function, along with its configuration

__init__(wrapped_function, **kwargs)

class quixote.Fetcher(wrapped_function, *, cached: bool = True, **kwargs)

Class wrapping a fetcher function, along with its configuration

__init__(wrapped_function, *, cached: bool = True, **kwargs)

class quixote.Inspector(wrapped_function, critical: bool = False, post_process: Optional[Callable[[], None]] = None, checklist_entry: Optional[str] = None, **kwargs)

Class wrapping an inspector function, along with its configuration

__init__(wrapped_function, critical: bool = False, post_process: Optional[Callable[[], None]] = None, checklist_entry: Optional[str] = None, **kwargs)

quixote.create_registries()

Create registries for functions marked as builders, fetchers, and inspectors, for the duration of a with-block

Returns

a tuple containing the three registries

quixote.builder(*args, **kwargs)

Decorator used to mark a function as a builder

quixote.fetcher(*args, **kwargs)

Decorator used to mark a function as a fetcher

Parameters

cached – whether or not the data fetched should be cached (default is False)

quixote.inspector(*args, **kwargs)

Decorator used to mark a function as an inspector

Parameters

critical – whether or not the inspection phase should be aborted if this step fails (default is False)

class quixote.Blueprint(name: str, author: str, inspection_file: Optional[str] = None, allow_docker: bool = False, metadata: Optional[Any] = None)

Class representing the blueprint of an automated-test job

__init__(name: str, author: str, inspection_file: Optional[str] = None, allow_docker: bool = False, metadata: Optional[Any] = None)

Create a blueprint

Parameters

• name – the name of the blueprint

• author – the author of the blueprint

• inspection_file – the file containing additional inspector functions (deprecated since 2.0)

• allow_docker – whether a docker engine should be made available in the inspection step

• metadata – custom metadata to attach to the blueprint

register_functions(builders=None, fetchers=None, inspectors=None)

Register functions marked as builders, fetchers, or inspectors in the blueprint

Parameters

• builders – the list of collected builders

• fetchers – the list of collected fetchers

• inspectors – the list of collected inspectors