test/com/facebook/buck/zip/RepackZipEntriesStepTest.java

/*
 * Copyright 2012-present Facebook, 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.facebook.buck.zip;

import static org.junit.Assert.assertArrayEquals;
import static org.junit.Assert.assertTrue;

import com.facebook.buck.step.TestExecutionContext;
import com.google.common.collect.ImmutableSet;
import com.google.common.io.Resources;

import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.net.URL;
import java.nio.file.Files;
import java.util.zip.ZipEntry;
import java.util.zip.ZipOutputStream;

public class RepackZipEntriesStepTest {

  @Rule public TemporaryFolder tmp = new TemporaryFolder();
  private File parent;
  private File zipFile;

  @Before
  public void buildSampleZipFile() throws IOException {
    parent = tmp.newFolder("foo");
    zipFile = new File(parent, "example.zip");

    // Turns out that the zip filesystem generates slightly different output from the output stream.
    // Since we've modeled our outputstreams after the zip output stream, be compatible with that.
    try (ZipOutputStream stream = new ZipOutputStream(new FileOutputStream(zipFile))) {
      ZipEntry entry = new ZipEntry("file");
      stream.putNextEntry(entry);
      String packageName = getClass().getPackage().getName().replace(".", "/");
      URL sample = Resources.getResource(packageName + "/sample-bytes.properties");
      stream.write(Resources.toByteArray(sample));
    }
  }

  @Test
  public void shouldLeaveZipAloneIfEntriesToCompressIsEmpty() throws IOException {
    File out = new File(parent, "output.zip");
    RepackZipEntriesStep step = new RepackZipEntriesStep(
        zipFile.getAbsolutePath(),
        out.getAbsolutePath(),
        ImmutableSet.<String>of());
    step.execute(TestExecutionContext.newInstance());

    byte[] expected = Files.readAllBytes(zipFile.toPath());
    byte[] actual = Files.readAllBytes(out.toPath());
    assertArrayEquals(expected, actual);
  }

  @Test
  public void repackWithHigherCompressionResultsInFewerBytes() throws IOException {
    File out = new File(parent, "output.zip");
    RepackZipEntriesStep step = new RepackZipEntriesStep(
        zipFile.getAbsolutePath(),
        out.getAbsolutePath(),
        ImmutableSet.of("file"));
    step.execute(TestExecutionContext.newInstance());

    assertTrue(out.length() < zipFile.length());
  }

  @Test
  public void justStoringEntriesLeadsToMoreBytesInOuputZip() throws IOException {
    File out = new File(parent, "output.zip");
    RepackZipEntriesStep step = new RepackZipEntriesStep(
        zipFile.getAbsolutePath(),
        out.getAbsolutePath(),
        ImmutableSet.of("file"),
        ZipStep.MIN_COMPRESSION_LEVEL);
    step.execute(TestExecutionContext.newInstance());

    byte[] expected = Files.readAllBytes(zipFile.toPath());
    byte[] actual = Files.readAllBytes(out.toPath());

    assertTrue(expected.length < actual.length);
  }
}