/*
* Copyright 2017 ThoughtWorks, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.thoughtworks.go.server.service;
import com.thoughtworks.go.domain.ConsoleOut;
import com.thoughtworks.go.domain.JobIdentifier;
import com.thoughtworks.go.domain.LocatableEntity;
import com.thoughtworks.go.domain.exception.IllegalArtifactLocationException;
import com.thoughtworks.go.server.view.artifacts.ArtifactDirectoryChooser;
import com.thoughtworks.go.server.view.artifacts.BuildIdArtifactLocator;
import com.thoughtworks.go.server.view.artifacts.PathBasedArtifactsLocator;
import com.thoughtworks.go.util.FileUtil;
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.IOUtils;
import org.apache.log4j.Logger;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import java.io.*;
import java.nio.charset.StandardCharsets;
import static com.thoughtworks.go.util.ArtifactLogUtil.getConsoleOutputFolderAndFileName;
@Component
public class ConsoleService {
public static final Logger LOGGER = Logger.getLogger(ConsoleService.class);
private ArtifactDirectoryChooser chooser;
public static final int DEFAULT_CONSOLE_LOG_LINE_BUFFER_SIZE = 1024;
private ArtifactsDirHolder artifactsDirHolder;
public ConsoleService(ArtifactDirectoryChooser chooser) {
this.chooser = chooser;
}
@Autowired
public ConsoleService(ArtifactsDirHolder artifactsDirHolder) {
this(new ArtifactDirectoryChooser());
this.artifactsDirHolder = artifactsDirHolder;
}
public void initialize() {
chooser.add(new PathBasedArtifactsLocator(artifactsDirHolder.getArtifactsDir()));
chooser.add(new BuildIdArtifactLocator(artifactsDirHolder.getArtifactsDir()));
}
ConsoleOut getConsoleOut(int startingLine, InputStream inputStream) throws IOException {
int lineNumber = 0;
StringBuilder builder = new StringBuilder();
try {
BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream, StandardCharsets.UTF_8));
String consoleLine;
while (null != (consoleLine = reader.readLine())) {
if (lineNumber >= startingLine) {
builder.append(consoleLine);
builder.append(FileUtil.lineSeparator());
}
lineNumber++;
}
} catch (FileNotFoundException ex) {
String message = "Could not read console out: " + ex.getMessage();
LOGGER.error(message);
LOGGER.trace(message, ex);
} finally {
inputStream.close();
}
return new ConsoleOut(builder.toString(), startingLine, lineNumber);
}
public ConsoleOut getConsoleOut(JobIdentifier identifier, int startingLine) throws IOException, IllegalArtifactLocationException {
return getConsoleOut(startingLine, new FileInputStream(findConsoleArtifact(identifier)));
}
public File findConsoleArtifact(JobIdentifier identifier) throws IllegalArtifactLocationException {
File file = chooser.temporaryConsoleFile(identifier);
if (!file.exists()) {
file = chooser.findArtifact(identifier, getConsoleOutputFolderAndFileName());
}
return file;
}
public File consoleLogFile(JobIdentifier jobIdentifier) throws IllegalArtifactLocationException {
File file = chooser.temporaryConsoleFile(jobIdentifier);
if (file.exists()) {
return file;
}
File finalConsole = chooser.findArtifact(jobIdentifier, getConsoleOutputFolderAndFileName());
if (finalConsole.exists()) return finalConsole;
return file;
}
public void appendToConsoleLog(JobIdentifier jobIdentifier, String text) throws IllegalArtifactLocationException, IOException {
File file = findConsoleArtifact(jobIdentifier);
updateConsoleLog(file, new ByteArrayInputStream(text.getBytes()));
}
public boolean updateConsoleLog(File dest, InputStream in) throws IOException {
File parentFile = dest.getParentFile();
parentFile.mkdirs();
LOGGER.trace("Updating console log [" + dest.getAbsolutePath() + "]");
try (OutputStream out = new BufferedOutputStream(new FileOutputStream(dest, dest.exists()))) {
IOUtils.copy(in, out);
} catch (IOException e) {
LOGGER.error("Failed to update console log at : [" + dest.getAbsolutePath() + "]", e);
return false;
}
if (LOGGER.isTraceEnabled()) {
LOGGER.trace("Console log [" + dest.getAbsolutePath() + "] saved.");
}
return true;
}
public void moveConsoleArtifacts(LocatableEntity locatableEntity) {
try {
File from = chooser.temporaryConsoleFile(locatableEntity);
// Job cancellation skips temporary file creation. Force create one if it does not exist.
FileUtils.touch(from);
File to = chooser.findArtifact(locatableEntity, getConsoleOutputFolderAndFileName());
FileUtils.moveFile(from, to);
} catch (IOException | IllegalArtifactLocationException e) {
throw new RuntimeException(e);
}
}
}