Package com.xebialabs.xlrelease.api.v1

Class BaseApiDocumentationTest

java.lang.Object

com.xebialabs.deployit.plumbing.XLReleaseTest

com.xebialabs.xlrelease.XLReleaseIntegrationTest

com.xebialabs.xlrelease.api.v1.BaseApiDocumentationTest

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public abstract class BaseApiDocumentationTest
extends XLReleaseIntegrationTest

Nested Class Summary

Nested classes/interfaces inherited from class com.xebialabs.xlrelease.XLReleaseIntegrationTest

XLReleaseIntegrationTest.DeleteOption

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.restdocs.mockmvc.RestDocumentationResultHandler	documentationHandler
com.xebialabs.xlrelease.rules.LoginRule	loginRule
protected org.springframework.test.web.servlet.MockMvc	mockMvc
org.springframework.restdocs.JUnitRestDocumentation	restDocumentation

Fields inherited from class com.xebialabs.xlrelease.XLReleaseIntegrationTest

applicationContext, archivedReleases, archivingService, cisForDeletion, commentRepository, configurationRepository, configurationService, eventually, facetService, featureServices, folderPersistence, folderService, gateConditionRepository, permissionEditor, permissionsSnapshotService, phaseRepository, planItemRepository, releaseActorLifecycleUtils, releaseRepository, releaseService, reportingJdbcTemplate, SPRING_CLASS_RULE, springMethodRule, storageFacade, teamService, testName, triggerActorLifecycleUtils, triggerRepository, txManager, userProfileRepository, userTokenRepository, userTokenService

Constructor Summary

Constructors

Constructor	Description
BaseApiDocumentationTest()

Method Summary

Modifier and Type	Method	Description
protected org.springframework.restdocs.payload.RequestFieldsSnippet	ciRequestFieldsSnippet(com.xebialabs.deployit.plugin.api.reflect.Type ciType)
protected org.springframework.restdocs.payload.ResponseFieldsSnippet	ciResponseFieldsSnippet(com.xebialabs.deployit.plugin.api.reflect.Type ciType)
protected org.springframework.restdocs.payload.ResponseFieldsSnippet	ciResponseFieldsSnippet(com.xebialabs.deployit.plugin.api.reflect.Type ciType, String prefix)
protected org.springframework.restdocs.operation.preprocess.OperationPreprocessor[]	getRequestDocsPreprocessors()
protected void	markForDeletion(org.springframework.test.web.servlet.MvcResult result)
protected org.springframework.restdocs.request.QueryParametersSnippet	paginatedRequestParametersSnippet()
protected org.springframework.restdocs.payload.RequestFieldsSnippet	releaseFiltersSnippet()
void	setUp()
protected String	toJson(com.xebialabs.deployit.plugin.api.udm.ConfigurationItem ci)
protected String	toJson(Object ci)
protected String	toJson(List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> cis)
protected String	toJsonWithPlainTextPassword(com.xebialabs.deployit.plugin.api.udm.ConfigurationItem ci)
protected org.springframework.restdocs.payload.RequestFieldsSnippet	variableRequestSnippet()

Methods inherited from class com.xebialabs.xlrelease.XLReleaseIntegrationTest

archiveRelease, before, captureLogs, createFolder, createFolder, createFolder, createRole, createRole, createTask, deleteFromArchive, deleteOnTearDown, deleteOnTearDown, deleteOrder, deleteRelease, deleteRelease, deleteRelease, encrypt, eventBus, featureServicesEnabled, getApplicationContext, getCisForDeletion, getGateCondition, getPhase, getPlanItem, getRelease, getTask, getVariable, grantGlobalPermissions, insertArchivedRelease, isRelaxedTest, markForDeletion, markForDeletion, markForDeletion, markForDeletion, preArchiveAndArchiveRelease, registerCloseable, resetTaskTimeouts, setApplicationContext, setSmallTaskTimeouts, storeChanges, storeConfiguration, storeRelease, storeRelease, storeRelease, storeRelease, storeTemplate, storeTemplate, storeTemplate, storeTemplate, storeTrigger, storeTrigger, tearDown, unmarkForDeletion, updatePhase, updateRelease, updateTask, updateTaskProperty, verifyRepositoryClean, verifyWorkdirClean, withAdmin, workDirVerificationEnabled

Methods inherited from class com.xebialabs.deployit.plumbing.XLReleaseTest

boot, setInternalState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

restDocumentation

public org.springframework.restdocs.JUnitRestDocumentation restDocumentation

loginRule

public com.xebialabs.xlrelease.rules.LoginRule loginRule

mockMvc

protected org.springframework.test.web.servlet.MockMvc mockMvc

documentationHandler

protected org.springframework.restdocs.mockmvc.RestDocumentationResultHandler documentationHandler

Constructor Details

BaseApiDocumentationTest

public BaseApiDocumentationTest()

Method Details

setUp

public void setUp()

getRequestDocsPreprocessors

protected org.springframework.restdocs.operation.preprocess.OperationPreprocessor[] getRequestDocsPreprocessors()

markForDeletion

protected void markForDeletion(org.springframework.test.web.servlet.MvcResult result)

paginatedRequestParametersSnippet

protected org.springframework.restdocs.request.QueryParametersSnippet paginatedRequestParametersSnippet()

ciRequestFieldsSnippet

protected org.springframework.restdocs.payload.RequestFieldsSnippet ciRequestFieldsSnippet(com.xebialabs.deployit.plugin.api.reflect.Type ciType)

ciResponseFieldsSnippet

protected org.springframework.restdocs.payload.ResponseFieldsSnippet ciResponseFieldsSnippet(com.xebialabs.deployit.plugin.api.reflect.Type ciType)

ciResponseFieldsSnippet

protected org.springframework.restdocs.payload.ResponseFieldsSnippet ciResponseFieldsSnippet(com.xebialabs.deployit.plugin.api.reflect.Type ciType,
 String prefix)

variableRequestSnippet

protected org.springframework.restdocs.payload.RequestFieldsSnippet variableRequestSnippet()

releaseFiltersSnippet

protected org.springframework.restdocs.payload.RequestFieldsSnippet releaseFiltersSnippet()

toJson

protected String toJson(com.xebialabs.deployit.plugin.api.udm.ConfigurationItem ci)
                 throws Exception

Throws:

Exception

toJsonWithPlainTextPassword

protected String toJsonWithPlainTextPassword(com.xebialabs.deployit.plugin.api.udm.ConfigurationItem ci)
                                      throws Exception

Throws:

Exception

toJson

protected String toJson(List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> cis)
                 throws Exception

Throws:

Exception

toJson

protected String toJson(Object ci)
                 throws Exception

Throws:

Exception