pdk-test 1.6.0

PDK Test
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

// Copyright (c) 2025, Salesforce, Inc.,
// All rights reserved.
// For full license text, see the LICENSE.txt file

//! PDK Integration Testing Framework
//!
//! Framework for writing non-blocking integration tests based on Docker containers.
//! It provides utilities for managing test environments, services and containers
//! in a controlled and isolated way.
//!
//! This library provides testing functionality with support for:
//!
//! - Docker container management and orchestration
//! - Predefined test services (Flex Gateway, HTTP mocks, gRPC services)
//! - Network port management and visibility control
//! - Test composite builders for complex scenarios
//! - Error handling for test failures and configuration issues
//!
//! ## Primary types
//!
//! - [`TestComposite`]: main test environment orchestrator
//! - [`TestCompositeBuilder`]: builder for configuring test environments
//! - [`TestError`]: error type for test failures and configuration issues
//! - [`services::flex::FlexConfig`]: Flex Gateway service configuration
//! - [`services::flex::ApiConfig`]: API configuration for Flex Gateway
//! - [`services::flex::PolicyConfig`]: policy configuration for Flex Gateway
//! - [`services::httpmock::HttpMockConfig`]: HTTPMock service configuration
//! - [`services::httpbin::HttpBinConfig`]: HTTPBin testing service configuration
//! - [`services::grpcbin::GrpcBinConfig`]: GrpcBin gRPC testing service configuration
//! - [`services::gripmock::GripMockConfig`]: GripMock gRPC mock service configuration
//!

pub mod error;
mod image;
pub mod port;
pub mod services;

mod config;
mod probe;
mod service;

pub(crate) mod cleanup;
mod composite;
pub(crate) mod constants;
mod container;
mod handle;
mod host;
mod host_container;
mod network;
mod portpicker;
mod runner;

pub use composite::{TestComposite, TestCompositeBuilder};
pub use error::TestError;
pub use pdk_test_macros::pdk_test;

// This module is for crate exclusive use
#[doc(hidden)]
pub mod __runner {
    pub use super::runner::*;
}