[#2161] One-Stop Config File for Code Portfolio

build.gradle

@@ -38,6 +38,8 @@ dependencies {
  implementation group: 'org.apache.ant', name: 'ant', version: '1.10.12'
  implementation group: 'org.apache.commons', name: 'commons-csv', version: '1.9.0'
  implementation group: 'org.fusesource.jansi', name: 'jansi', version: '2.4.0'
+ implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.17.0'
+ implementation group: 'com.fasterxml.jackson.dataformat', name: 'jackson-dataformat-yaml', version: '2.17.0'
 
  testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
  testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion

config/report-config.yaml

@@ -0,0 +1,11 @@
+repoUrl: github.com/user/repo
+reportTitle: RepoSense Report
+authorDisplayName: Sample Author
+authorGithubId: Sample Author Github ID
+branches:
+ - name: Branch 1
+ blurb: Blurb 1
+ - name: Branch 2
+ blurb: Blurb 2
+startDate: 2020-01-01
+endDate: 9999-12-31

docs/ug/configFiles.md

@@ -107,12 +107,22 @@ e.g.: `example.java` in `example-repo` can either be in the `test` group or the
 
 <!-- ==================================================================================================== -->
 
-## `report-config.json`
+## `report-config.yaml`
 
-You can optionally use `report-config.json` to customize report generation by providing the following information. ([example](report-config.json))
+You can also optionally use a `report-config.json` file to quickly define the repository information for the repositories you are interested in tracking and generate your very own code portfolio.
+
+View this [example](report-config.yaml) for a better understanding of what repository information is required.
 
 **Fields to provide**:
-* `title`: Title of the generated report, which is also the title of the deployed dashboard. Default: "RepoSense Report"
+* `repoUrl`: The URL to your repository of interest
+* `reportTitle`: Title of the generated report, which is also the title of the deployed dashboard. Default: "RepoSense Report"
+* `authorDisplayName`: Name of the author to track in the repository.
+* `authorGithubId`: The GitHub username of the author to track in the repository.
+* `branches`: A list of branches with their associated blurbs.
+ * `name`: Name of the branch to track
+ * `blurb`: Blurb to include with the branch
+* `startDate`: The start date of analysis for RepoSense. Default: "2020-01-01"
+* `endDate`: The end date of analysis for RepoSense. Default: "9999-12-32"
 
 <!-- ==================================================================================================== -->
 

docs/ug/report-config.yaml

@@ -0,0 +1,11 @@
+repoUrl: github.com/user/repo
+reportTitle: RepoSense Report
+authorDisplayName: Sample Author
+authorGithubId: Sample Author Github ID
+branches:
+ - name: Branch 1
+ blurb: Blurb 1
+ - name: Branch 2
+ blurb: Blurb 2
+startDate: 2020-01-01
+endDate: 9999-12-31

src/main/java/reposense/model/CliArguments.java

@@ -11,7 +11,7 @@
 import reposense.parser.AuthorConfigCsvParser;
 import reposense.parser.GroupConfigCsvParser;
 import reposense.parser.RepoConfigCsvParser;
-import reposense.parser.ReportConfigJsonParser;
+import reposense.parser.ReportConfigYamlParser;
 
 /**
  * Represents command line arguments user supplied when running the program.
@@ -155,6 +155,10 @@
  return reportConfigFilePath;
  }
 
+ public ReportConfiguration getReportYamlConfiguration() {
+ return reportConfiguration;
+ }
+
  public ReportConfiguration getReportConfiguration() {
  return reportConfiguration;
  }
@@ -441,7 +445,8 @@
  this.cliArguments.groupConfigFilePath = configFolderPath.resolve(
  GroupConfigCsvParser.GROUP_CONFIG_FILENAME);
  this.cliArguments.reportConfigFilePath = configFolderPath.resolve(
- ReportConfigJsonParser.REPORT_CONFIG_FILENAME);
+ ReportConfigYamlParser.REPORT_CONFIG_FILENAME);
+
  return this;
  }
 

src/main/java/reposense/model/ReportConfiguration.java

@@ -1,13 +1,85 @@
 package reposense.model;
 
+import java.time.LocalDate;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
 /**
- * Represents configuration information from JSON config file for generated report.
+ * Class that contains information on a report's configurations.
+ * This class is used mainly for quickly setting up one's personal code portfolio.
  */
 public class ReportConfiguration {
- private static final String DEFAULT_TITLE = "RepoSense Report";
- private String title;
+ public static final String DEFAULT_REPO_URL = "github.com/user/repo";
+ public static final String DEFAULT_TITLE = "RepoSense Report";
+ public static final String DEFAULT_AUTHOR_DISPLAY_NAME = "Sample Author";
+ public static final String DEFAULT_AUTHOR_GITHUB_ID = "Sample Author Github ID";
+ public static final List<Map<String, String>> DEFAULT_BRANCHES_WITH_BLURBS = new ArrayList<>();
+ public static final LocalDate DEFAULT_START_DATE = LocalDate.of(2020, 1, 1);
+ public static final LocalDate DEFAULT_END_DATE = LocalDate.of(9999, 12, 31);
+
+ private static final HashMap<String, String> DEFAULT_BRANCH_ONE = new HashMap<>();
+ private static final HashMap<String, String> DEFAULT_BRANCH_TWO = new HashMap<>();
+
+ @JsonProperty("repoUrl")
+ private String repoUrl;
+
+ @JsonProperty("reportTitle")
+ private String reportTitle;
+
+ @JsonProperty("authorDisplayName")
+ private String authorDisplayName;
+
+ @JsonProperty("authorGithubId")
+ private String authorGithubId;
+
+ @JsonProperty("startDate")
+ private LocalDate startDate;
+
+ @JsonProperty("endDate")
+ private LocalDate endDate;
+
+ @JsonProperty("branches")
+ private List<Map<String, String>> branchesWithBlurbs;
+
+ // SIB to set the default values in the maps
+ static {
+ DEFAULT_BRANCH_ONE.put("name", "Branch 1");
+ DEFAULT_BRANCH_ONE.put("blurb", "Blurb 1");
+ DEFAULT_BRANCH_TWO.put("name", "Branch 2");
+ DEFAULT_BRANCH_TWO.put("blurb", "Blurb 2");
+ DEFAULT_BRANCHES_WITH_BLURBS.add(DEFAULT_BRANCH_ONE);
+ DEFAULT_BRANCHES_WITH_BLURBS.add(DEFAULT_BRANCH_TWO);
+ }
+
+ public String getReportTitle() {
+ return reportTitle == null ? DEFAULT_TITLE : reportTitle;
+ }
+
+ public String getAuthorDisplayName() {
+ return authorDisplayName == null ? DEFAULT_AUTHOR_DISPLAY_NAME : authorDisplayName;
+ }
+
+ public String getAuthorGithubId() {
+ return authorGithubId == null ? DEFAULT_AUTHOR_GITHUB_ID : authorGithubId;
+ }
+
+ public LocalDate getStartDate() {
+ return startDate == null ? DEFAULT_START_DATE : startDate;
+ }
+
+ public LocalDate getEndDate() {
+ return endDate == null ? DEFAULT_END_DATE : endDate;
+ }
+
+ public String getRepoUrl() {
+ return repoUrl == null ? DEFAULT_REPO_URL : repoUrl;
+ }
 
- public String getTitle() {
- return (title == null) ? DEFAULT_TITLE : title;
+ public List<Map<String, String>> getBranchesWithBlurbs() {
+ return branchesWithBlurbs == null ? DEFAULT_BRANCHES_WITH_BLURBS : branchesWithBlurbs;
  }
 }

src/main/java/reposense/parser/ArgsParser.java

@@ -361,10 +361,10 @@ private static void addReportConfigToBuilder(CliArguments.Builder builder, Names
 
  // Report config is ignored if --repos is provided
  if (locations == null) {
- Path reportConfigFilePath = configFolderPath.resolve(ReportConfigJsonParser.REPORT_CONFIG_FILENAME);
+ Path reportConfigFilePath = configFolderPath.resolve(ReportConfigYamlParser.REPORT_CONFIG_FILENAME);
 
  try {
- reportConfig = new ReportConfigJsonParser().parse(reportConfigFilePath);
+ reportConfig = new ReportConfigYamlParser().parse(reportConfigFilePath);
  } catch (JsonSyntaxException jse) {
  logger.warning(String.format(MESSAGE_INVALID_CONFIG_PATH, reportConfigFilePath));
  } catch (IllegalArgumentException iae) {

src/main/java/reposense/parser/ReportConfigYamlParser.java

@@ -0,0 +1,59 @@
+package reposense.parser;
+
+import java.io.File;
+import java.io.IOException;
+import java.lang.reflect.Type;
+import java.nio.file.Path;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+import com.fasterxml.jackson.databind.JsonMappingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
+import com.google.gson.Gson;
+
+import reposense.model.ReportConfiguration;
+import reposense.system.LogsManager;
+
+/**
+ * YAML Parser for report-config.yaml files.
+ */
+public class ReportConfigYamlParser extends JsonParser<ReportConfiguration> {
+ public static final String REPORT_CONFIG_FILENAME = "report-config.yaml";
+ private static final Logger logger = LogsManager.getLogger(ReportConfigYamlParser.class);
+
+ @Override
+ public Type getType() {
+ return ReportConfiguration.class;
+ }
+
+ @Override
+ public ReportConfiguration parse(Path path) throws IOException {
+ return this.fromJson(null, path, null);
+ }
+
+ @Override
+ protected ReportConfiguration fromJson(Path path) throws IOException {
+ return this.fromJson(null, path, null);
+ }
+
+ @Override
+ protected ReportConfiguration fromJson(Gson gson, Path path, Type type) throws IOException , JsonMappingException {
+ // adapted from https://www.baeldung.com/jackson-yaml
+ ReportConfiguration reportConfigation;
+
+ try {
+ logger.log(Level.INFO, "Parsing report-config.yaml file...");
+ ObjectMapper mapper = new ObjectMapper(new YAMLFactory());
+ mapper.findAndRegisterModules();
+ reportConfigation = mapper.readValue(new File(path.toString()), ReportConfiguration.class);
+ logger.log(Level.INFO, "report-config.yaml file parsed successfully!");
+ } catch (IOException ioe) {
+ // if the parse fails for any reason, the default config file is used instead
+ logger.log(Level.WARNING, "Error parsing report-config.yaml: " + ioe.getMessage(), ioe);
+ reportConfigation = new ReportConfiguration();
+ }
+
+ return reportConfigation;
+ }
+}

src/main/java/reposense/report/ReportGenerator.java

@@ -87,7 +87,7 @@ public class ReportGenerator {
  private static final String LOG_ERROR_CLONING_OR_BRANCHING = "Exception met while cloning or checking out.";
  private static final String LOG_UNEXPECTED_ERROR = "Unexpected error stack trace for %s:\n>%s";
  private static final List<String> assetsFilesWhiteList =
- Collections.unmodifiableList(Arrays.asList(new String[] {"favicon.ico", "title.md"}));
+ Collections.unmodifiableList(Arrays.asList("favicon.ico", "title.md"));
 
  private LocalDateTime earliestSinceDate = null;
  private ProgressTracker progressTracker = null;

src/main/java/reposense/report/SummaryJson.java

@@ -35,7 +35,7 @@ public SummaryJson(List<RepoConfiguration> repos, ReportConfiguration reportConf
  this.repos = repos;
  this.reportGeneratedTime = reportGeneratedTime;
  this.reportGenerationTime = reportGenerationTime;
- this.reportTitle = reportConfig.getTitle();
+ this.reportTitle = reportConfig.getReportTitle();
  this.sinceDate = sinceDate;
  this.untilDate = untilDate;
  this.isSinceDateProvided = isSinceDateProvided;

src/systemtest/resources/ConfigSystemTest/report-config.yaml

@@ -0,0 +1,11 @@
+repoUrl: github.com/user/repo
+reportTitle: RepoSense Report Test Title
+authorDisplayName: Sample Author
+authorGithubId: Sample Author Github ID
+branches:
+ - name: Branch 1
+ blurb: Blurb 1
+ - name: Branch 2
+ blurb: Blurb 2
+startDate: 2020-01-01
+endDate: 9999-12-31