Package io.quarkiverse.githubapp.testing.dsl

Interface GitHubMockSetupContext

All Superinterfaces:

GitHubMockContext

All Known Implementing Classes:

GitHubMockContextImpl

public interface GitHubMockSetupContext
extends GitHubMockContext

Method Summary

Modifier and Type	Method	Description
GitHubMockConfigFileSetupContext	configFile(String pathInRepository)	Starts mocking the fetching of a configuration file from the GitHub repository of an event.
GitHubMockConfigFileSetupContext	configFile(org.kohsuke.github.GHRepository repository, String pathInRepository)	Starts mocking the fetching of a configuration file from a given GitHub repository mock.
default void	configFileFromClasspath(String pathInRepository, String pathInClasspath)	Deprecated, for removal: This API element is subject to removal in a future version. Call configFile(pathInRepository).fromClasspath(pathInClassPath) instead.
default void	configFileFromString(String pathInRepository, String configFile)	Deprecated. Call configFile(pathInRepository).fromString(configFile) instead.

Methods inherited from interface io.quarkiverse.githubapp.testing.dsl.GitHubMockContext

applicationClient, client, ghObject, ghObjects, graphQLClient, installationClient, installationGraphQLClient, issue, issueComment, pullRequest, repository, team

Method Details

configFileFromClasspath

@Deprecated(forRemoval=true)
default void configFileFromClasspath(String pathInRepository,
 String pathInClasspath)
                              throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Call configFile(pathInRepository).fromClasspath(pathInClassPath) instead. Will be removed in version 2 of this extension.

Mocks the fetching of a configuration file from the GitHub repository of an event, using a file from the classpath as stubbed content.

Parameters:

pathInRepository - The path of the file passed to ConfigFile.value().

pathInClasspath - The path of the content to use in the classpath.

Throws:

IOException - If reading the content from the classpath fails.

See Also:

• ConfigFile

configFileFromString

@Deprecated
default void configFileFromString(String pathInRepository,
 String configFile)

Deprecated.

Call configFile(pathInRepository).fromString(configFile) instead. Will be removed in version 2 of this extension.

Mocks the fetching of a configuration file from the GitHub repository of an event, using a given string as stubbed content.

Parameters:

pathInRepository - The path of the file passed to ConfigFile.value().

configFile - The content of the configuration file as a string.

See Also:

• ConfigFile

configFile

GitHubMockConfigFileSetupContext configFile(String pathInRepository)

Starts mocking the fetching of a configuration file from the GitHub repository of an event.

Parameters:

pathInRepository - The path of the file passed to ConfigFile.value().

Returns:

A context to set the stubbed content of the file.

See Also:

• ConfigFile

configFile

GitHubMockConfigFileSetupContext configFile(org.kohsuke.github.GHRepository repository,
 String pathInRepository)

Starts mocking the fetching of a configuration file from a given GitHub repository mock.

Parameters:

repository - The repository mock, generally retrieved from GitHubMockContext.repository(String).

pathInRepository - The path of the file passed to GitHubConfigFileProvider.fetchConfigFile(GHRepository, String, ConfigFile.Source, Class).

See Also:

• GitHubMockContext.repository(String)
• GitHubConfigFileProvider.fetchConfigFile(GHRepository, String, ConfigFile.Source, Class)