Skip to content

Commit

Permalink
Improve generator code
Browse files Browse the repository at this point in the history
  • Loading branch information
Maduranga Siriwardena committed Sep 13, 2024
1 parent a4a9dc8 commit 95172be
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 107 deletions.
93 changes: 34 additions & 59 deletions ...oco-report-generator/src/main/java/org/wso2/carbon/identity/jacoco/CodeCoverageUtils.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,37 +26,36 @@
import java.util.zip.ZipEntry;
import java.util.zip.ZipInputStream;

/**
* Utility class for code coverage related operations.
*/
public class CodeCoverageUtils {

private static final int BUFFER_SIZE = 1024;
private static final String INVALID_EXTENSION_ERROR = "Invalid extension: %s is invalid";
private static final String EXTRACTION_ERROR = "Error on archive extraction";

/**
* Extract jar files given at jar file path
*
* @param jarFilePath - Jar file patch
* @param jarFilePath - Jar file path
* @param tempDir - Temporary directory to extract jar file
* @return - Jar file extracted directory.
* @throws IOException - Throws if jar extraction fails
*/
public synchronized static String extractJarFile(String jarFilePath, File tempDir)
throws IOException {
public synchronized static String extractJarFile(String jarFilePath, File tempDir) throws IOException {

if (!jarFilePath.endsWith(".war") && !jarFilePath.endsWith(".jar")) {
throw new IllegalArgumentException("Invalid extension" + jarFilePath + " is invalid");
throw new IllegalArgumentException(String.format(INVALID_EXTENSION_ERROR, jarFilePath));
}

String fileSeparator = (File.separatorChar == '\\') ? "\\" : File.separator;
String jarFileName = jarFilePath;

if (jarFilePath.lastIndexOf(fileSeparator) != -1) {
jarFileName = jarFilePath.substring(jarFilePath.lastIndexOf(fileSeparator) + 1);
}
String jarFileName = new File(jarFilePath).getName();
String tempExtractedDir = new File(tempDir, jarFileName.substring(0, jarFileName.lastIndexOf('.'))).getPath();

String tempExtractedDir = null;
try {
tempExtractedDir = tempDir + File.separator +
jarFileName.substring(0, jarFileName.lastIndexOf('.'));

extractFile(jarFilePath, tempExtractedDir);
} catch (IOException e) {
System.out.println("Could not extract the file " + jarFileName);
throw new IOException("Could not extract the file " + jarFileName, e);
}
return tempExtractedDir;
}
Expand All @@ -72,6 +71,7 @@ public synchronized static String extractJarFile(String jarFilePath, File tempDi
*/
public static String[] scanDirectory(String jarExtractedDir, String[] includes,
String[] excludes) throws IOException {

DirectoryScanner ds = new DirectoryScanner();

ds.setIncludes(includes);
Expand All @@ -84,57 +84,32 @@ public static String[] scanDirectory(String jarExtractedDir, String[] includes,
}

public static void extractFile(String sourceFilePath, String extractedDir) throws IOException {
FileOutputStream fileoutputstream = null;
String fileDestination = extractedDir + File.separator;
byte[] buf = new byte[1024];
ZipInputStream zipinputstream = null;
ZipEntry zipentry;
try {
zipinputstream = new ZipInputStream(new FileInputStream(sourceFilePath));
zipentry = zipinputstream.getNextEntry();
while (zipentry != null) {
//for each entry to be extracted
String entryName = fileDestination + zipentry.getName();
entryName = entryName.replace('/', File.separatorChar);
entryName = entryName.replace('\\', File.separatorChar);
int n;
File newFile = new File(entryName);
if (zipentry.isDirectory()) {
if (!newFile.exists()) {
if (!newFile.mkdirs()) {
throw new IOException("Error occurred created new directory");
}

byte[] buf = new byte[BUFFER_SIZE];
try (ZipInputStream zipInputStream = new ZipInputStream(new FileInputStream(sourceFilePath))) {
ZipEntry zipEntry;
while ((zipEntry = zipInputStream.getNextEntry()) != null) {
File newFile = new File(extractedDir, zipEntry.getName());
if (zipEntry.isDirectory()) {
if (!newFile.isDirectory() && !newFile.mkdirs()) {
throw new IOException("Failed to create directory " + newFile);
}
zipentry = zipinputstream.getNextEntry();
continue;
} else {
File resourceFile =
new File(entryName.substring(0, entryName.lastIndexOf(File.separator)));
if (!resourceFile.exists()) {
if (!resourceFile.mkdirs()) {
break;
File parent = newFile.getParentFile();
if (!parent.isDirectory() && !parent.mkdirs()) {
throw new IOException("Failed to create directory " + parent);
}
try (FileOutputStream fos = new FileOutputStream(newFile)) {
int len;
while ((len = zipInputStream.read(buf)) > 0) {
fos.write(buf, 0, len);
}
}
}
fileoutputstream = new FileOutputStream(entryName);
while ((n = zipinputstream.read(buf, 0, 1024)) > -1) {
fileoutputstream.write(buf, 0, n);
}
fileoutputstream.close();
zipinputstream.closeEntry();
zipentry = zipinputstream.getNextEntry();
zipInputStream.closeEntry();
}
zipinputstream.close();
} catch (IOException e) {
System.out.println("Error on archive extraction ");
throw new IOException("Error on archive extraction ", e);
} finally {
if (fileoutputstream != null) {
fileoutputstream.close();
}
if (zipinputstream != null) {
zipinputstream.close();
}
throw new IOException(EXTRACTION_ERROR, e);
}
}
}
83 changes: 35 additions & 48 deletions ...acoco-report-generator/src/main/java/org/wso2/carbon/identity/jacoco/ReportGenerator.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ public class ReportGenerator {
public static final String CLASS_FILE_PATTERN = "**/*.class";

private final String title;

private final File executionDataFile;
private final Set<File> classDirectories;
private final File xmlReport;
Expand All @@ -57,18 +56,17 @@ public class ReportGenerator {
* @param classDirectories the set of class directories
*/
public ReportGenerator(File executionDataFile, Set<File> classDirectories) {
this.title = "something";

this.title = "Jacoco Coverage Report";
this.executionDataFile = executionDataFile;
this.classDirectories = classDirectories;
this.xmlReport = new File("./report/jacoco.xml");
this.tempDirectory = new File("./tmp");

// Create report directory if it does not exist
File reportDir = this.xmlReport.getParentFile();
if (!reportDir.exists()) {
if (!reportDir.mkdirs()) {
throw new RuntimeException("Failed to create report directory: " + reportDir.getAbsolutePath());
}
if (!reportDir.exists() && !reportDir.mkdirs()) {
throw new RuntimeException("Failed to create report directory: " + reportDir.getAbsolutePath());
}
}

Expand All @@ -92,77 +90,65 @@ public void create() throws IOException {
final IBundleCoverage bundleCoverage = analyzeStructure();

createReport(bundleCoverage);

}

private void createReport(final IBundleCoverage bundleCoverage)
throws IOException {
private void createReport(final IBundleCoverage bundleCoverage) throws IOException {

// Create a concrete report visitor based on some supplied
// configuration. In this case we use the defaults
final XMLFormatter xmlFormatter = new XMLFormatter();
final IReportVisitor visitor = xmlFormatter.createVisitor(new FileOutputStream(xmlReport));

// Initialize the report with all the execution and session
// information. At this point the report doesn't know about the
// structure of the report being created
visitor.visitInfo(execFileLoader.getSessionInfoStore().getInfos(),
execFileLoader.getExecutionDataStore().getContents());

// Populate the report structure with the bundle coverage information.
// Call visitGroup if you need groups in your report.
visitor.visitBundle(bundleCoverage,
new DirectorySourceFileLocator(null, "utf-8", 4));

// Signal end of structure information to allow report to write all
// information out
visitor.visitEnd();
try (FileOutputStream fos = new FileOutputStream(xmlReport)) {
final XMLFormatter xmlFormatter = new XMLFormatter();
final IReportVisitor visitor = xmlFormatter.createVisitor(fos);

// Initialize the report with all the execution and session
// information. At this point the report doesn't know about the
// structure of the report being created
visitor.visitInfo(execFileLoader.getSessionInfoStore().getInfos(),
execFileLoader.getExecutionDataStore().getContents());

// Populate the report structure with the bundle coverage information.
// Call visitGroup if you need groups in your report.
visitor.visitBundle(bundleCoverage,
new DirectorySourceFileLocator(null, "utf-8", 4));

// Signal end of structure information to allow report to write all
// information out
visitor.visitEnd();
}
}

private void loadExecutionData() throws IOException {

execFileLoader = new ExecFileLoader();
execFileLoader.load(executionDataFile);
}

private IBundleCoverage analyzeStructure() throws IOException {

final CoverageBuilder coverageBuilder = new CoverageBuilder();
final Analyzer analyzer = new Analyzer(
execFileLoader.getExecutionDataStore(), coverageBuilder);
final Analyzer analyzer = new Analyzer(execFileLoader.getExecutionDataStore(), coverageBuilder);

List<File> jarFilesToAnalyze = new ArrayList<>();
List<File> classFilesToAnalyze = new ArrayList<>();

for (File classDirectory : classDirectories) {
// Jar files to analyze
File [] files = classDirectory.listFiles(new FilenameFilter() {
@Override
public boolean accept(File dir, String name) {
return name.startsWith("org.wso2.carbon") && !name.contains(".stub_");
}
});

if (files != null) {
jarFilesToAnalyze.addAll(Arrays.asList(files));
}
File[] files = classDirectory.listFiles((dir, name) -> name.startsWith("org.wso2.carbon") && !name.contains(".stub_"));
if (files != null) {
jarFilesToAnalyze.addAll(Arrays.asList(files));
}

// Class files to analyze
files = classDirectory.listFiles(new FilenameFilter() {
@Override
public boolean accept(File dir, String name) {
return name.endsWith(".class");
}
});

files = classDirectory.listFiles((dir, name) -> name.endsWith(".class"));
if (files != null) {
classFilesToAnalyze.addAll(Arrays.asList(files));
}
}
}

String[] includes = {CLASS_FILE_PATTERN};
String[] excludes = {"-*.stub*", "-*.stub_", "-*.stub_4.0.0", "-*.stub-"};

for (final File jarFile : jarFilesToAnalyze) {

String extractedDir = CodeCoverageUtils.extractJarFile(jarFile.getAbsolutePath(), tempDirectory);
String[] classFiles = CodeCoverageUtils.scanDirectory(extractedDir, includes, excludes);

Expand All @@ -187,13 +173,14 @@ public boolean accept(File dir, String name) {
* @throws IOException
*/
public static void main(final String[] args) throws IOException {

if (args.length < 2) {
System.err.println("Usage: java -jar ReportGenerator.jar <executionDataFile> <classDirectory1> [<classDirectory2> ...]");
System.exit(1);
}

File executionDataFile = new File(args[0]);
Set<File> classDirectories = new HashSet<File>();
Set<File> classDirectories = new HashSet<>();
for (int i = 1; i < args.length; i++) {
classDirectories.add(new File(args[i]));
}
Expand Down

0 comments on commit 95172be

Please sign in to comment.