io.crums.testing.IoTestCase Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2024 Babak Farhang
 */
package io.crums.testing;


import java.io.File;



/**
 * A convention for output file paths for unit tests. We don't want running
 * tests twice without cleaning to fail. This works by numbering paths per
 * invocation in ascending order at the leaves of the directory structure.
 * 
 * The other approach would be to assign a global root directory
 * per invocation of tests. That looks cleaner but it has the downside you
 * now have to keep track of what a run of a suite of tests is (which will
 * depend on assumptions about the test harness). Way too brittle, imo.
 * 
 */
public class IoTestCase extends SelfAwareTestCase {
  
  
  public final File outputDir;

  /**
   * 
   */
  public IoTestCase() {
    TestOutputFiles testDirs = new TestOutputFiles();
    this.outputDir = testDirs.getOutputPath(getClass());
    outputDir.mkdirs();
    if (!outputDir.isDirectory())
      throw new IllegalStateException("failed to create test output dir " + outputDir);
  }
  
  
  
  /**
   * Returns the path to a newly created method run directory.
   * 
   * @param innerMethodObject
   *        an instance of an anonymous type declared in the body of the test method
   *        
   * @return a newly created directory
   */
  public File newMethodRunDir(Object innerMethodObject) {
    File runDir = getMethodOutputFilepath(innerMethodObject);
    if (!runDir.mkdirs())
      throw new IllegalStateException(
          "failed to create test run-directory " + runDir);
    
    return runDir;
  }
  
  
  /**
   * Careful, returns the same directory across invocations.
   * 
   * @param innerMethodObject
   *        an instance of an anonymous type declared in the body of the test method
   * 
   * @see #method(Object)
   */
  public File getMethodOutputDir(Object innerMethodObject) {
    File dir = new File(outputDir, method(innerMethodObject));
    dir.mkdir();
    if (!dir.isDirectory())
      throw new IllegalStateException(
          "failed to create test method output directory " + dir);
    
    return dir;
  }
  
  /**
   * Returns a new file path for this run of the test. The object doesn't yet exist:
   * it can be turned into a directory or regular file.
   * 
   * @param innerMethodObject
   *        an instance of an anonymous type declared in the body of the test method
   * 
   * @see #method(Object)
   */
  public File getMethodOutputFilepath(Object innerMethodObject) {
    return getMethodOutputFilepath(innerMethodObject, "RUN-", null);
  }
  
  public File getMethodOutputFilepath(Object innerMethodObject, String prefix) {
    return getMethodOutputFilepath(innerMethodObject, prefix, null);
  }
  
  public File getMethodOutputFilepath(Object innerMethodObject, String prefix, String postfix) {
    File dir = getMethodOutputDir(innerMethodObject);
    // max 99 invocations w/o cleaning (deliberate!)
    return new IntPathnameGenerator(dir, prefix, 2, postfix).newPath();
  }

}