foreman

type BatchFactsResult struct {
	HostIDs []int64
	Facts   map[string]map[string]string
	// Missing lists the hosts the batch asked for that came back with no fact at
	// all. Knowing the ids that were requested is the whole point of batching by
	// host: without it, a host absent from the response is indistinguishable
	// from a host that simply has nothing matching the search.
	Missing   []string
	Pages     int
	Truncated bool
	Err       error
}

type ClientConfig struct {
	BaseURL       *url.URL
	Username      string
	Password      string
	SkipTLSVerify bool

	// Concurrency caps the in-flight requests fanned out per collector.
	Concurrency int64
	// MaxConnsPerHost sizes the idle connection pool. 0 derives it from
	// Concurrency. It is not a hard cap on open connections: both collectors can
	// fan out at the same time, so capping would make them queue on the
	// transport instead of on their own semaphore.
	MaxConnsPerHost int64
	Limit           int64
	RetryMax        int64
	// RetryMaxWait caps the Retry-After delay honored on 429/503 (0 = no cap).
	RetryMaxWait time.Duration
	// RateLimit paces outgoing requests, in requests per second (0 = disabled).
	// It bounds throughput, where Concurrency bounds parallelism: the two are
	// independent, and which one binds depends on how fast foreman answers.
	RateLimit float64
	// RateLimitBurst is the token bucket depth. 0 derives it from RateLimit.
	RateLimitBurst int64

	Search               string
	SearchHostFact       string
	IncludeHostFactRegex *regexp.Regexp
	ExcludeHostFactRegex *regexp.Regexp

	// BulkFacts switches the host fact collection to /api/v2/fact_values, one
	// request per batch of host ids. FactNames, when set, pushes the fact-name
	// selection to the server instead of downloading everything and filtering
	// it away client-side.
	BulkFacts      bool
	FactBatchSize  int64
	FactPerPage    int64
	FactMaxPages   int64
	FactNames      []string
	FactInOperator string
	MaxURLLength   int
	// HostListPerPage sizes the thin host list pages the fact collector walks
	// before collecting anything. 0 uses the built-in default.
	HostListPerPage int64

	Log *logrus.Logger
}

type ErrorResult struct {
	Status int64  `json:"status"`
	Error  string `json:"error"`
}

type HTTPClient struct {
	BaseURL  *url.URL
	Username string
	Password string

	Concurrency          int64
	Limit                int64
	Search               string
	SearchHostFact       string
	IncludeHostFactRegex *regexp.Regexp
	ExcludeHostFactRegex *regexp.Regexp
	Log                  *logrus.Logger

	// BulkFacts collects facts through /api/v2/fact_values by batch of host ids
	// instead of one request per host.
	BulkFacts       bool
	FactBatchSize   int64
	FactPerPage     int64
	FactMaxPages    int64
	FactNames       []string
	FactInOperator  string
	MaxURLLength    int
	HostListPerPage int64
	// contains filtered or unexported fields
}

type Host struct {
	ID                       int64  `json:"id"`
	Name                     string `json:"name"`
	GlobalStatusLabel        string `json:"global_status_label,omitempty"`
	ConfigurationStatusLabel string `json:"configuration_status_label,omitempty"`
	BuildStatusLabel         string `json:"build_status_label,omitempty"`
	OrganizationName         string `json:"organization_name,omitempty"`
	EnvironmentName          string `json:"environment_name,omitempty"`
	OperatingSystemName      string `json:"operatingsystem_name,omitempty"`
	OwnerName                string `json:"owner_name,omitempty"`
	LocationName             string `json:"location_name,omitempty"`
	ModelName                string `json:"model_name,omitempty"`
	HostgroupName            string `json:"hostgroup_name,omitempty"`
}

type HostFactsResponse struct {
	Total   int64                        `json:"total"`
	Page    int64                        `json:"page"`
	PerPage int64                        `json:"per_page"`
	Results map[string]map[string]string `json:"results"`
}

type HostFactsWithConcurrencyResult struct {
	Index  int
	Result HostFactsResponse
	Error  error
}

type HostResponse struct {
	Total int64 `json:"total"`
	// Subtotal is how many records match the search. Foreman sets it equal to
	// Total when no search is given; Total itself always counts every record,
	// so paginating on Total overshoots as soon as a search filter is set. It is
	// a pointer so that a search matching nothing (subtotal 0) is not mistaken
	// for a foreman version that does not report the field at all.
	Subtotal *int64 `json:"subtotal"`
	Page     int64  `json:"page"`
	PerPage  int64  `json:"per_page"`
	Results  []Host `json:"results"`
}

type HostWithConcurrencyResult struct {
	Index  int
	Result HostResponse
	Error  error
}

type LeveledLogrus struct {
	*logrus.Logger
}

type RequestCompletionCallback func(*http.Request, *http.Response)