util

Documentation

Index

• func CheckArtifactoryLicense(client *resty.Client, licenseTypesToCheck ...string) error
• func CheckEnvVars(vars []string, defaultValue string) string
• func CheckVersion(versionToCheck string, supportedVersion string) (bool, error)
• func ExecuteTemplate(name, temp string, fields interface{}) string
• func GetArtifactoryVersion(client *resty.Client) (string, error)
• func GetXrayVersion(client *resty.Client) (string, error)
• func OIDCTokenExchange(ctx context.Context, client *resty.Client, providerName, credentialTag string) (string, error)
• func SendUsage(ctx context.Context, req *resty.Request, productId string, ...)
• func SendUsageResourceCreate(ctx context.Context, req *resty.Request, productId, resourceName string)
• func SendUsageResourceDelete(ctx context.Context, req *resty.Request, productId, resourceName string)
• func SendUsageResourceRead(ctx context.Context, req *resty.Request, productId, resourceName string)
• func SendUsageResourceUpdate(ctx context.Context, req *resty.Request, productId, resourceName string)
• type Feature
• type Identifiable
• type JFrogError
• type JFrogErrors
  • func (e JFrogErrors) String() string
• type JFrogResource
  • func (r *JFrogResource) Configure(ctx context.Context, req resource.ConfigureRequest, ...)
  • func (r *JFrogResource) Metadata(_ context.Context, req resource.MetadataRequest, ...)
  • func (r JFrogResource) ValidateConfig(ctx context.Context, req resource.ValidateConfigRequest, ...)
• type OIDCAccessTokenRequest
• type OIDCAccessTokenResponse
• type ProviderMetadata
• type UsageStruct

Functions

func CheckArtifactoryLicense

func CheckArtifactoryLicense(client *resty.Client, licenseTypesToCheck ...string) error

func CheckEnvVars

func CheckEnvVars(vars []string, defaultValue string) string

func CheckVersion

func CheckVersion(versionToCheck string, supportedVersion string) (bool, error)

func ExecuteTemplate

func ExecuteTemplate(name, temp string, fields interface{}) string

func GetArtifactoryVersion

func GetArtifactoryVersion(client *resty.Client) (string, error)

func GetXrayVersion

func GetXrayVersion(client *resty.Client) (string, error)

func OIDCTokenExchange

func OIDCTokenExchange(ctx context.Context, client *resty.Client, providerName, credentialTag string) (string, error)

OIDCTokenExchange use TFC_WORKLOAD_IDENTITY_TOKEN env var value to exchange for a access token using OIDC provider configured on JFrog platform

func SendUsage

func SendUsage(ctx context.Context, req *resty.Request, productId string, featureUsages ...string)

func SendUsageResourceCreate

func SendUsageResourceCreate(ctx context.Context, req *resty.Request, productId, resourceName string)

func SendUsageResourceDelete

func SendUsageResourceDelete(ctx context.Context, req *resty.Request, productId, resourceName string)

func SendUsageResourceRead

func SendUsageResourceRead(ctx context.Context, req *resty.Request, productId, resourceName string)

func SendUsageResourceUpdate

func SendUsageResourceUpdate(ctx context.Context, req *resty.Request, productId, resourceName string)

Types

type Feature

type Feature struct {
	FeatureId string `json:"featureId"`
}

type Identifiable

type Identifiable interface {
	Id() string
}

type JFrogError

type JFrogError struct {
	Code    string `json:"code"`
	Message string `json:"message"`
}

type JFrogErrors

type JFrogErrors struct {
	Errors []JFrogError `json:"errors"`
}

func (JFrogErrors) String

func (e JFrogErrors) String() string

type JFrogResource

type JFrogResource struct {
	ProviderData            *ProviderMetadata
	TypeName                string
	ValidArtifactoryVersion string
	DocumentEndpoint        string
	CollectionEndpoint      string
}

func (*JFrogResource) Configure

func (r *JFrogResource) Configure(ctx context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)

func (*JFrogResource) Metadata

func (r *JFrogResource) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse)

func (JFrogResource) ValidateConfig

func (r JFrogResource) ValidateConfig(ctx context.Context, req resource.ValidateConfigRequest, resp *resource.ValidateConfigResponse)

type OIDCAccessTokenRequest

type OIDCAccessTokenRequest struct {
	GrantType        string `json:"grant_type"`
	SubjectTokenType string `json:"subject_token_type"`
	SubjectToken     string `json:"subject_token"`
	ProviderName     string `json:"provider_name"`
}

type OIDCAccessTokenResponse

type OIDCAccessTokenResponse struct {
	AccessToken string `json:"access_token"`
}

type ProviderMetadata

type ProviderMetadata struct {
	Client             *resty.Client
	ProductId          string
	ArtifactoryVersion string
	XrayVersion        string
}

type UsageStruct

type UsageStruct struct {
	ProductId string    `json:"productId"`
	Features  []Feature `json:"features"`
}