Function validate_api_spec

pants-plugins/api_spec/rules.py:118–161

(
    request: ValidateAPISpecRequest.Batch,
    subsystem: ValidateApiSpec,
)

    level=LogLevel.DEBUG,
)
async def validate_api_spec(
    request: ValidateAPISpecRequest.Batch,
    subsystem: ValidateApiSpec,
) -> LintResult:
    source_files_get = Get(
        SourceFiles,
        SourceFilesRequest(field_set.source for field_set in request.elements),
    )

    config_files_get = Get(ConfigFiles, ConfigFilesRequest, subsystem.config_request())

    # We use a pex to actually validate the api spec with an external script.
    # Validation cannot be inlined here because it needs to import the st2 code.
    # (the script location is defined on the ValidateApiSpec subsystem)
    pex_get = Get(VenvPex, PexFromTargetsRequest, subsystem.pex_request())

    source_files, config_files, pex = await MultiGet(
        source_files_get, config_files_get, pex_get
    )

    input_digest = await Get(
        Digest,
        MergeDigests((config_files.snapshot.digest, source_files.snapshot.digest)),
    )

    process_result = await Get(
        FallibleProcessResult,
        VenvPexProcess(
            pex,
            argv=(
                "--config-file",
                subsystem.config_file,
                # TODO: Uncomment these as part of a project to fix the (many) issues it identifies.
                #       We can uncomment --validate-defs (and possibly --verbose) once the spec defs are valid.
                # "--validate-defs",  # check for x-api-model in definitions
                # "--verbose",  # show model definitions on failure (only applies to --validate-defs)
            ),
            input_digest=input_digest,
            description="Validating openapi.yaml api spec",
            level=LogLevel.DEBUG,
        ),
    )

    return LintResult.create(request, process_result)


def rules():