use of org.craftercms.studio.api.v1.constant.StudioConstants.IN_PROGRESS_BRANCH_NAME_SUFFIX in project studio by craftercms.
the class GitContentRepository method publish.
@RetryingOperation
@Override
public void publish(String site, String sandboxBranch, List<DeploymentItemTO> deploymentItems, String environment, String author, String comment) throws DeploymentException {
if (CollectionUtils.isEmpty(deploymentItems)) {
return;
}
String commitId = EMPTY;
String gitLockKey = SITE_PUBLISHED_REPOSITORY_GIT_LOCK.replaceAll(PATTERN_SITE, site);
generalLockService.lock(gitLockKey);
try {
GitRepositoryHelper helper = GitRepositoryHelper.getHelper(studioConfiguration, securityService, userServiceInternal, encryptor, generalLockService, retryingRepositoryOperationFacade);
Repository repo = helper.getRepository(site, PUBLISHED);
boolean repoCreated = false;
if (Objects.isNull(repo)) {
helper.createPublishedRepository(site, sandboxBranch);
repo = helper.getRepository(site, PUBLISHED);
repoCreated = Objects.nonNull(repo);
}
String path = EMPTY;
String sandboxBranchName = sandboxBranch;
if (StringUtils.isEmpty(sandboxBranchName)) {
sandboxBranchName = studioConfiguration.getProperty(REPO_SANDBOX_BRANCH);
}
synchronized (repo) {
try (Git git = new Git(repo)) {
String inProgressBranchName = environment + IN_PROGRESS_BRANCH_NAME_SUFFIX;
// fetch "origin/master"
logger.debug("Fetch from sandbox for site " + site);
FetchCommand fetchCommand = git.fetch();
retryingRepositoryOperationFacade.call(fetchCommand);
// checkout master and pull from sandbox
logger.debug("Checkout published/master branch for site " + site);
try {
// First delete it in case it already exists (ignored if does not exist)
String currentBranch = repo.getBranch();
if (currentBranch.endsWith(IN_PROGRESS_BRANCH_NAME_SUFFIX)) {
ResetCommand resetCommand = git.reset().setMode(HARD);
retryingRepositoryOperationFacade.call(resetCommand);
}
Ref ref = repo.exactRef(R_HEADS + sandboxBranchName);
boolean createBranch = (ref == null);
CheckoutCommand checkoutCommand = git.checkout().setName(sandboxBranchName).setCreateBranch(createBranch);
retryingRepositoryOperationFacade.call(checkoutCommand);
logger.debug("Delete in-progress branch, in case it was not cleaned up for site " + site);
DeleteBranchCommand deleteBranchCommand = git.branchDelete().setBranchNames(inProgressBranchName).setForce(true);
retryingRepositoryOperationFacade.call(deleteBranchCommand);
PullCommand pullCommand = git.pull().setRemote(DEFAULT_REMOTE_NAME).setRemoteBranchName(sandboxBranchName).setStrategy(THEIRS);
retryingRepositoryOperationFacade.call(pullCommand);
} catch (RefNotFoundException e) {
logger.error("Failed to checkout published master and to pull content from sandbox for site " + site, e);
throw new DeploymentException("Failed to checkout published master and to pull content from " + "sandbox for site " + site);
}
// checkout environment branch
logger.debug("Checkout environment branch " + environment + " for site " + site);
try {
CheckoutCommand checkoutCommand = git.checkout().setName(environment);
retryingRepositoryOperationFacade.call(checkoutCommand);
} catch (RefNotFoundException e) {
logger.info("Not able to find branch " + environment + " for site " + site + ". Creating new branch");
// create new environment branch
// it will start as empty orphan branch
CheckoutCommand checkoutCommand = git.checkout().setOrphan(true).setForceRefUpdate(true).setStartPoint(sandboxBranchName).setUpstreamMode(TRACK).setName(environment);
retryingRepositoryOperationFacade.call(checkoutCommand);
// remove any content to create empty branch
RmCommand rmcmd = git.rm();
File[] toDelete = repo.getWorkTree().listFiles();
for (File toDel : toDelete) {
if (!repo.getDirectory().equals(toDel) && !StringUtils.equals(toDel.getName(), DOT_GIT_IGNORE)) {
rmcmd.addFilepattern(toDel.getName());
}
}
retryingRepositoryOperationFacade.call(rmcmd);
CommitCommand commitCommand = git.commit().setMessage(helper.getCommitMessage(REPO_INITIAL_COMMIT_COMMIT_MESSAGE)).setAllowEmpty(true);
retryingRepositoryOperationFacade.call(commitCommand);
}
// Create in progress branch
try {
// Create in progress branch
logger.debug("Create in-progress branch for site " + site);
CheckoutCommand checkoutCommand = git.checkout().setCreateBranch(true).setForceRefUpdate(true).setStartPoint(environment).setUpstreamMode(TRACK).setName(inProgressBranchName);
retryingRepositoryOperationFacade.call(checkoutCommand);
} catch (GitAPIException e) {
// TODO: DB: Error ?
logger.error("Failed to create in-progress published branch for site " + site);
}
Set<String> deployedCommits = new HashSet<String>();
Set<String> deployedPackages = new HashSet<String>();
logger.debug("Checkout deployed files started.");
AddCommand addCommand = git.add();
for (DeploymentItemTO deploymentItem : deploymentItems) {
commitId = deploymentItem.getCommitId();
path = helper.getGitPath(deploymentItem.getPath());
if (Objects.isNull(commitId) || !commitIdExists(site, PUBLISHED, commitId)) {
if (contentExists(site, path)) {
if (Objects.isNull(commitId)) {
logger.warn("Commit ID is NULL for content " + path + ". Was the git repo reset at some point?");
} else {
logger.warn("Commit ID " + commitId + " does not exist for content " + path + ". Was the git repo reset at some point?");
}
logger.info("Publishing content from HEAD for " + path);
commitId = getRepoLastCommitId(site);
} else {
logger.warn("Skipping file " + path + " because commit id is null");
continue;
}
}
logger.debug("Checking out file " + path + " from commit id " + commitId + " for site " + site);
CheckoutCommand checkout = git.checkout();
checkout.setStartPoint(commitId).addPath(path);
retryingRepositoryOperationFacade.call(checkout);
if (deploymentItem.isMove()) {
if (!StringUtils.equals(deploymentItem.getPath(), deploymentItem.getOldPath())) {
String oldPath = helper.getGitPath(deploymentItem.getOldPath());
RmCommand rmCommand = git.rm().addFilepattern(oldPath).setCached(false);
retryingRepositoryOperationFacade.call(rmCommand);
cleanUpMoveFolders(git, oldPath);
}
}
if (deploymentItem.isDelete()) {
String deletePath = helper.getGitPath(deploymentItem.getPath());
boolean isPage = deletePath.endsWith(FILE_SEPARATOR + INDEX_FILE);
RmCommand rmCommand = git.rm().addFilepattern(deletePath).setCached(false);
retryingRepositoryOperationFacade.call(rmCommand);
Path parentToDelete = Paths.get(path).getParent();
deleteParentFolder(git, parentToDelete, isPage);
}
deployedCommits.add(commitId);
String packageId = deploymentItem.getPackageId();
if (StringUtils.isNotEmpty(packageId)) {
deployedPackages.add(deploymentItem.getPackageId());
}
addCommand.addFilepattern(path);
objectMetadataManager.updateLastPublishedDate(site, deploymentItem.getPath(), ZonedDateTime.now(UTC));
}
logger.debug("Checkout deployed files completed.");
// commit all deployed files
String commitMessage = studioConfiguration.getProperty(REPO_PUBLISHED_COMMIT_MESSAGE);
logger.debug("Get Author Ident started.");
User user = userServiceInternal.getUserByIdOrUsername(-1, author);
PersonIdent authorIdent = helper.getAuthorIdent(user);
logger.debug("Get Author Ident completed.");
logger.debug("Git add all published items started.");
retryingRepositoryOperationFacade.call(addCommand);
logger.debug("Git add all published items completed.");
commitMessage = commitMessage.replace("{username}", author);
commitMessage = commitMessage.replace("{datetime}", ZonedDateTime.now(UTC).format(DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HHmmssSSSX")));
commitMessage = commitMessage.replace("{source}", "UI");
commitMessage = commitMessage.replace("{message}", comment);
StringBuilder sb = new StringBuilder();
for (String c : deployedCommits) {
sb.append(c).append(" ");
}
StringBuilder sbPackage = new StringBuilder();
for (String p : deployedPackages) {
sbPackage.append(p).append(" ");
}
commitMessage = commitMessage.replace("{commit_id}", sb.toString().trim());
commitMessage = commitMessage.replace("{package_id}", sbPackage.toString().trim());
logger.debug("Git commit all published items started.");
String prologue = studioConfiguration.getProperty(REPO_COMMIT_MESSAGE_PROLOGUE);
String postscript = studioConfiguration.getProperty(REPO_COMMIT_MESSAGE_POSTSCRIPT);
StringBuilder sbCommitMessage = new StringBuilder();
if (StringUtils.isNotEmpty(prologue)) {
sbCommitMessage.append(prologue).append("\n\n");
}
sbCommitMessage.append(commitMessage);
if (StringUtils.isNotEmpty(postscript)) {
sbCommitMessage.append("\n\n").append(postscript);
}
CommitCommand commitCommand = git.commit().setMessage(sbCommitMessage.toString()).setAuthor(authorIdent);
RevCommit revCommit = retryingRepositoryOperationFacade.call(commitCommand);
logger.debug("Git commit all published items completed.");
int commitTime = revCommit.getCommitTime();
// tag
ZonedDateTime tagDate2 = Instant.ofEpochSecond(commitTime).atZone(UTC);
ZonedDateTime publishDate = ZonedDateTime.now(UTC);
String tagName2 = tagDate2.format(DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HHmmssSSSX")) + "_published_on_" + publishDate.format(DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HHmmssSSSX"));
logger.debug("Get Author Ident started.");
PersonIdent authorIdent2 = helper.getAuthorIdent(user);
logger.debug("Get Author Ident completed.");
logger.debug("Git tag started.");
TagCommand tagCommand = git.tag().setTagger(authorIdent2).setName(tagName2).setMessage(commitMessage);
retryingRepositoryOperationFacade.call(tagCommand);
logger.debug("Git tag completed.");
// checkout environment
logger.debug("Checkout environment " + environment + " branch for site " + site);
CheckoutCommand checkoutCommand = git.checkout().setName(environment);
retryingRepositoryOperationFacade.call(checkoutCommand);
Ref branchRef = repo.findRef(inProgressBranchName);
// merge in-progress branch
logger.debug("Merge in-progress branch into environment " + environment + " for site " + site);
MergeCommand mergeCommand = git.merge().setCommit(true).include(branchRef);
retryingRepositoryOperationFacade.call(mergeCommand);
// clean up
logger.debug("Delete in-progress branch (clean up) for site " + site);
DeleteBranchCommand deleteBranchCommand = git.branchDelete().setBranchNames(inProgressBranchName).setForce(true);
retryingRepositoryOperationFacade.call(deleteBranchCommand);
git.close();
if (repoCreated) {
siteService.setPublishedRepoCreated(site);
}
}
}
} catch (Exception e) {
logger.error("Error when publishing site " + site + " to environment " + environment, e);
throw new DeploymentException("Error when publishing site " + site + " to environment " + environment + " [commit ID = " + commitId + "]");
} finally {
generalLockService.unlock(gitLockKey);
}
}
Aggregations