fix LBCORE-169

Author: ceki

logback-core/src/main/java/ch/qos/logback/core/rolling/TimeBasedFileNamingAndTriggeringPolicyBase.java

@@ -55,7 +55,6 @@ public void start() {
             + "'.");
     rc.printPeriodicity(this);
 
-
     setDateInCurrentPeriod(new Date(getCurrentTime()));
     if (tbrp.getParentsRawFileProperty() != null) {
       File currentFile = new File(tbrp.getParentsRawFileProperty());

logback-core/src/main/java/ch/qos/logback/core/rolling/helper/Compressor.java

@@ -22,14 +22,16 @@
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipOutputStream;
 
+import ch.qos.logback.core.rolling.RolloverFailure;
 import ch.qos.logback.core.spi.ContextAwareBase;
 import ch.qos.logback.core.status.ErrorStatus;
 import ch.qos.logback.core.status.WarnStatus;
+import ch.qos.logback.core.util.FileUtil;
 
 /**
  * The <code>Compression</code> class implements ZIP and GZ file
  * compression/decompression methods.
- * 
+ *
  * @author Ceki G&uuml;lc&uuml;
  */
 public class Compressor extends ContextAwareBase {
@@ -40,25 +42,22 @@ public Compressor(CompressionMode compressionMode) {
     this.compressionMode = compressionMode;
   }
 
-    /**
-     *
-     * @param nameOfFile2Compress
-     * @param nameOfCompressedFile
-     * @param innerEntryName The name of the file within the zip file. Use for ZIP compression.
-     */
+  /**
+   * @param nameOfFile2Compress
+   * @param nameOfCompressedFile
+   * @param innerEntryName       The name of the file within the zip file. Use for ZIP compression.
+   */
   public void compress(String nameOfFile2Compress, String nameOfCompressedFile, String innerEntryName) {
     switch (compressionMode) {
-    case GZ:
-      addInfo("GZ compressing [" + nameOfFile2Compress + "].");
-      gzCompress(nameOfFile2Compress, nameOfCompressedFile);
-      break;
-    case ZIP:
-      addInfo("ZIP compressing [" + nameOfFile2Compress + "].");
-      zipCompress(nameOfFile2Compress, nameOfCompressedFile, innerEntryName);
-      break;
-    case NONE:
-      throw new UnsupportedOperationException(
-          "compress method called in NONE compression mode");
+      case GZ:
+        gzCompress(nameOfFile2Compress, nameOfCompressedFile);
+        break;
+      case ZIP:
+        zipCompress(nameOfFile2Compress, nameOfCompressedFile, innerEntryName);
+        break;
+      case NONE:
+        throw new UnsupportedOperationException(
+                "compress method called in NONE compression mode");
     }
   }
 
@@ -67,12 +66,12 @@ private void zipCompress(String nameOfFile2zip, String nameOfZippedFile, String
 
     if (!file2zip.exists()) {
       addStatus(new WarnStatus("The file to compress named [" + nameOfFile2zip
-          + "] does not exist.", this));
+              + "] does not exist.", this));
 
       return;
     }
 
-    if(innerEntryName == null) {
+    if (innerEntryName == null) {
       addStatus(new WarnStatus("The innerEntryName parameter cannot be null", this));
       return;
     }
@@ -85,11 +84,14 @@ private void zipCompress(String nameOfFile2zip, String nameOfZippedFile, String
 
     if (zippedFile.exists()) {
       addStatus(new WarnStatus("The target compressed file named ["
-          + nameOfZippedFile + "] exist already.", this));
+              + nameOfZippedFile + "] exist already.", this));
 
       return;
     }
 
+    addInfo("ZIP compressing [" + file2zip + "] as ["+zippedFile+"]");
+    createMissingTargetDirsIfNecessary(zippedFile);
+
     BufferedInputStream bis = null;
     ZipOutputStream zos = null;
     try {
@@ -113,20 +115,20 @@ private void zipCompress(String nameOfFile2zip, String nameOfZippedFile, String
 
       if (!file2zip.delete()) {
         addStatus(new WarnStatus("Could not delete [" + nameOfFile2zip + "].",
-            this));
+                this));
       }
     } catch (Exception e) {
       addStatus(new ErrorStatus("Error occurred while compressing ["
-          + nameOfFile2zip + "] into [" + nameOfZippedFile + "].", this, e));
+              + nameOfFile2zip + "] into [" + nameOfZippedFile + "].", this, e));
     } finally {
-      if(bis != null) {
+      if (bis != null) {
         try {
           bis.close();
         } catch (IOException e) {
           // ignore
         }
       }
-      if(zos != null) {
+      if (zos != null) {
         try {
           zos.close();
         } catch (IOException e) {
@@ -168,24 +170,27 @@ private void gzCompress(String nameOfFile2gz, String nameOfgzedFile) {
 
     if (!file2gz.exists()) {
       addStatus(new WarnStatus("The file to compress named [" + nameOfFile2gz
-          + "] does not exist.", this));
+              + "] does not exist.", this));
 
       return;
     }
 
+
     if (!nameOfgzedFile.endsWith(".gz")) {
       nameOfgzedFile = nameOfgzedFile + ".gz";
     }
 
     File gzedFile = new File(nameOfgzedFile);
 
     if (gzedFile.exists()) {
-      addStatus(new WarnStatus("The target compressed file named ["
-          + nameOfgzedFile + "] exist already.", this));
-
+      addWarn("The target compressed file named ["
+              + nameOfgzedFile + "] exist already. Aborting file compression.");
       return;
     }
 
+    addInfo("GZ compressing [" + file2gz + "] as ["+gzedFile+"]");
+    createMissingTargetDirsIfNecessary(gzedFile);
+
     BufferedInputStream bis = null;
     GZIPOutputStream gzos = null;
     try {
@@ -205,20 +210,20 @@ private void gzCompress(String nameOfFile2gz, String nameOfgzedFile) {
 
       if (!file2gz.delete()) {
         addStatus(new WarnStatus("Could not delete [" + nameOfFile2gz + "].",
-            this));
+                this));
       }
     } catch (Exception e) {
       addStatus(new ErrorStatus("Error occurred while compressing ["
-          + nameOfFile2gz + "] into [" + nameOfgzedFile + "].", this, e));
+              + nameOfFile2gz + "] into [" + nameOfgzedFile + "].", this, e));
     } finally {
-      if(bis != null) {
+      if (bis != null) {
         try {
           bis.close();
         } catch (IOException e) {
           // ignore
         }
       }
-      if(gzos != null) {
+      if (gzos != null) {
         try {
           gzos.close();
         } catch (IOException e) {
@@ -233,24 +238,38 @@ static public String computeFileNameStr_WCS(String fileNamePatternStr,
     int len = fileNamePatternStr.length();
     switch (compressionMode) {
       case GZ:
-    	  if(fileNamePatternStr.endsWith(".gz")) 
-            return fileNamePatternStr.substring(0, len - 3);
-    	  else 
-    		 return fileNamePatternStr;
+        if (fileNamePatternStr.endsWith(".gz"))
+          return fileNamePatternStr.substring(0, len - 3);
+        else
+          return fileNamePatternStr;
       case ZIP:
-    	  if(fileNamePatternStr.endsWith(".zip")) 
-    	  return fileNamePatternStr.substring(0, len - 4);
-    	  else 
-    		return fileNamePatternStr;	  
+        if (fileNamePatternStr.endsWith(".zip"))
+          return fileNamePatternStr.substring(0, len - 4);
+        else
+          return fileNamePatternStr;
       case NONE:
         return fileNamePatternStr;
     }
     throw new IllegalStateException("Execution should not reach this point");
   }
 
+
+  void createMissingTargetDirsIfNecessary(File file) {
+    if (FileUtil.isParentDirectoryCreationRequired(file)) {
+      boolean result = FileUtil.createMissingParentDirectories(file);
+      if (!result) {
+        addError("Failed to create parent directories for ["
+                + file.getAbsolutePath() + "]");
+      } else {
+        addInfo("Created missing parent directories for ["
+                + file.getAbsolutePath() + "]");
+      }
+    }
+  }
+
   @Override
   public String toString() {
-    return "c.q.l.core.rolling.helper.Compress";
+    return this.getClass().getName();
   }
 
 }

logback-core/src/test/java/ch/qos/logback/core/util/Compare.java

@@ -19,16 +19,21 @@
 import java.io.FileReader;
 import java.io.IOException;
 import java.io.InputStreamReader;
+import java.util.Enumeration;
 import java.util.zip.GZIPInputStream;
+import java.util.zip.ZipEntry;
+import java.util.zip.ZipFile;
+import java.util.zip.ZipInputStream;
 
 public class Compare {
   static final int B1_NULL = -1;
   static final int B2_NULL = -2;
 
   public static boolean compare(String file1, String file2) throws FileNotFoundException, IOException {
     if (file1.endsWith(".gz")) {
-      //System.out.println(file1 +" is a gz file");
       return gzFileCompare(file1, file2);
+    } else if(file1.endsWith(".zip")) {
+      return zipFileCompare(file1, file2);
     } else {
       return regularFileCompare(file1, file2);
     }
@@ -39,13 +44,24 @@ static BufferedReader gzFileToBufferedReader(String file) throws IOException {
     GZIPInputStream gzis = new GZIPInputStream(fis);
     return new BufferedReader(new InputStreamReader(gzis));
   }
-  
+
+  static BufferedReader zipFileToBufferedReader(String file) throws IOException {
+    FileInputStream fis = new FileInputStream(file);
+    ZipInputStream zis = new  ZipInputStream(fis);
+    zis.getNextEntry();
+    return new BufferedReader(new InputStreamReader(zis));
+  }
   public static boolean gzFileCompare(String file1, String file2) throws IOException {
     BufferedReader in1 = gzFileToBufferedReader(file1);
     BufferedReader in2 = gzFileToBufferedReader(file2);
     return bufferCompare(in1, in2, file1, file2);
   }
 
+  public static boolean zipFileCompare(String file1, String file2) throws IOException {
+    BufferedReader in1 = zipFileToBufferedReader(file1);
+    BufferedReader in2 = zipFileToBufferedReader(file2);
+    return bufferCompare(in1, in2, file1, file2);
+  }
   public static boolean regularFileCompare(String file1, String file2)
       throws FileNotFoundException, IOException {
     BufferedReader in1 = new BufferedReader(new FileReader(file1));

logback-core/src/test/scala/ch/qos/logback/core/rolling/RollingScaffolding.scala

@@ -6,15 +6,15 @@
  * either the terms of the Eclipse Public License v1.0 as published by
  * the Eclipse Foundation
  *
- *   or (per the licensee's choosing)
+ * or (per the licensee's choosing)
  *
  * under the terms of the GNU Lesser General Public License version 2.1
  * as published by the Free Software Foundation.
  */
 package ch.qos.logback.core.rolling
 
 import ch.qos.logback.core.{ContextBase, Context}
-import helper.FileFilterUtil
+import helper.{FileNamePattern, FileFilterUtil}
 import java.util.concurrent.TimeUnit
 import ch.qos.logback.core.util.{CachingDateFormatter, CoreTestConstants}
 import org.junit.Assert._
@@ -29,7 +29,7 @@ trait RollingScaffolding {
 
   val context: Context = new ContextBase
   val sm = context.getStatusManager()
-  
+
   var diff: Int = RandomUtil.getPositiveInt
 
   protected var currentTime: Long = 0L
@@ -63,24 +63,23 @@ trait RollingScaffolding {
     return new Date(currentTime - delta)
   }
 
-  protected def addExpectedFileName_ByDate(outputDir: String, testId: String, millis: Long, gzExtension: Boolean): Unit = {
-    var fn: String = outputDir + testId + "-" + SDF.format(millis)
-    if (gzExtension) {
-      fn += ".gz"
-    }
+  protected def addExpectedFileName_ByDate(patternStr: String, millis: Long): Unit = {
+    val fileNamePattern = new FileNamePattern(patternStr, context)
+    var fn: String = fileNamePattern.convert(new Date(millis))
+    println("fn=" + fn)
     expectedFilenameList = expectedFilenameList ::: List(fn)
 
   }
 
   protected def addExpectedFileName_ByFileIndexCounter(randomOutputDir: String, testId: String, millis: Long, fileIndexCounter: Int, compressionSuffix: String): Unit = {
-    var fn: String = randomOutputDir + testId + "-" + SDF.format(millis) + "-" + fileIndexCounter + ".txt"+compressionSuffix
+    var fn: String = randomOutputDir + testId + "-" + SDF.format(millis) + "-" + fileIndexCounter + ".txt" + compressionSuffix
     expectedFilenameList = expectedFilenameList ::: List(fn)
   }
 
-    
-  protected def addExpectedFileNamedIfItsTime_ByDate(outputDir: String, testId: String, gzExtension: Boolean): Unit = {
+
+  protected def addExpectedFileNamedIfItsTime_ByDate(fileNamePatternStr: String): Unit = {
     if (passThresholdTime(nextRolloverThreshold)) {
-      addExpectedFileName_ByDate(outputDir, testId, getMillisOfCurrentPeriodsStart, gzExtension)
+      addExpectedFileName_ByDate(fileNamePatternStr, getMillisOfCurrentPeriodsStart)
       recomputeRolloverThreshold(currentTime)
     }
   }
@@ -112,9 +111,16 @@ trait RollingScaffolding {
   // =========================================================================
   // utility methods
   // =========================================================================
-  private[rolling] def massageExpectedFilesToCorresponToCurrentTarget(file: String): Unit = {
+  private[rolling] def massageExpectedFilesToCorresponToCurrentTarget(file: String, fileOptionIsSet: Boolean): Unit = {
+    val last: String = expectedFilenameList.last
     expectedFilenameList = expectedFilenameList.dropRight(1)
-    expectedFilenameList = expectedFilenameList ::: List(file) 
+
+    if (fileOptionIsSet) {
+      expectedFilenameList = expectedFilenameList ::: List(file)
+    } else if (last.endsWith(".gz")) {
+      val stem = last.dropRight(3)
+      expectedFilenameList = expectedFilenameList ::: List(stem)
+    }
   }
 
   def existenceCheck(filenameList: List[String]): Unit = {
@@ -133,7 +139,7 @@ trait RollingScaffolding {
     FileFilterUtil.sortFileArrayByName(fileArray)
     fileContentCheck(fileArray, runLength, prefix)
   }
-   
+
   def reverseSortedContentCheck(outputDirStr: String, runLength: Int, prefix: String) {
     var fileArray: Array[File] = getFilesInDirectory(outputDirStr)
     FileFilterUtil.reverseSortFileArrayByName(fileArray)

logback-core/src/test/scala/ch/qos/logback/core/rolling/SizeAndTimeBasedFNATP_STest.scala

@@ -106,9 +106,9 @@ class SizeAndTimeBasedFNATP_STest extends RollingScaffolding {
       secondPhase
       runLength = runLength*2
     }
-    
+
     if (stem != null)
-      massageExpectedFilesToCorresponToCurrentTarget(file)
+      massageExpectedFilesToCorresponToCurrentTarget(file, true)
 
     Thread.sleep(20)
     // wait for compression to finish