ch.ivyteam.ivy.maven.TestIarPackagingMojo.java Source code

Introduction

Here is the source code for ch.ivyteam.ivy.maven.TestIarPackagingMojo.java

Source

/*
 * Copyright (C) 2015 AXON IVY AG
 *
 * 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 ch.ivyteam.ivy.maven;

import static org.assertj.core.api.Assertions.assertThat;

import java.io.File;
import java.io.IOException;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.zip.ZipFile;

import org.apache.commons.io.FileUtils;
import org.apache.maven.model.FileSet;
import org.junit.Rule;
import org.junit.Test;

/**
 * @author Reguel Wermelinger
 * @since 03.11.2014
 */
public class TestIarPackagingMojo {

    @Rule
    public ProjectMojoRule<IarPackagingMojo> rule = new ProjectMojoRule<IarPackagingMojo>(
            new File("src/test/resources/base"), IarPackagingMojo.GOAL) {
        @Override
        protected void before() throws Throwable {
            super.before();
            createEmptySrcDirs();
        }

        private void createEmptySrcDirs() throws IOException {
            List<String> emptySrcDirNames = Arrays.asList("src_dataClasses", "src_hd", "src_rd", "src_ws",
                    "src_wsproc");
            for (String emptySrcDirName : emptySrcDirNames) {
                File srcDir = new File(projectDir, emptySrcDirName);
                FileUtils.deleteDirectory(srcDir);
                srcDir.mkdir();
            }
        }
    };

    /**
     * Happy path creation tests
     * @throws Exception
     */
    @Test
    public void archiveCreationDefault() throws Exception {
        IarPackagingMojo mojo = rule.getMojo();
        File svn = new File(mojo.project.getBasedir(), ".svn/svn.txt");
        FileUtils.write(svn, "svn");
        mojo.execute();
        Collection<File> iarFiles = FileUtils.listFiles(new File(mojo.project.getBasedir(), "target"),
                new String[] { "iar" }, false);
        assertThat(iarFiles).hasSize(1);

        File iarFile = iarFiles.iterator().next();
        assertThat(iarFile.getName()).isEqualTo("base-1.0.0.iar");
        assertThat(mojo.project.getArtifact().getFile())
                .as("Created IAR must be registered as artifact for later repository installation.")
                .isEqualTo(iarFile);

        try (ZipFile archive = new ZipFile(iarFile)) {
            assertThat(archive.getEntry(".classpath")).as(".classpath must be packed for internal binary retrieval")
                    .isNotNull();
            assertThat(archive.getEntry("src_hd")).as("Empty directories should be included (by default) "
                    + "so that the IAR can be re-imported into the designer").isNotNull();
            assertThat(archive.getEntry("target/sampleOutput.txt")).as("'target' folder should not be packed")
                    .isNull();
            assertThat(archive.getEntry("target")).as("'target'folder should not be packed").isNull();
            assertThat(archive.getEntry(".svn/svn.txt")).as("'.svn' folder should not be packed").isNull();
            assertThat(archive.getEntry(".svn")).as("'target'.svn should not be packed").isNull();
            assertThat(archive.getEntry("classes/gugus.txt")).as("classes content should be included by default")
                    .isNotNull();
        }
    }

    @Test
    public void canDefineCustomExclusions() throws Exception {
        IarPackagingMojo mojo = rule.getMojo();
        String filterCandidate = "private/notPublic.txt";
        assertThat(new File(mojo.project.getBasedir(), filterCandidate)).exists();

        mojo.iarExcludes = new String[] { "private", "private/**/*" };
        mojo.execute();
        try (ZipFile archive = new ZipFile(mojo.project.getArtifact().getFile())) {
            assertThat(archive.getEntry("private")).as("Custom exclusion must be filtered").isNull();
            assertThat(archive.getEntry(filterCandidate)).as("Custom exclusion must be filtered").isNull();
            assertThat(archive.size()).isGreaterThan(50).as("archive must contain content");
        }
    }

    @Test
    public void canDefineCustomInclusions() throws Exception {
        IarPackagingMojo mojo = rule.getMojo();
        File outputDir = new File(mojo.project.getBasedir(), "target");
        File customPomXml = new File(outputDir, "myCustomPom.xml");
        FileUtils.write(customPomXml, "customPomContent");

        String relativeCustomIncludePath = "target/" + customPomXml.getName();
        FileSet fs = new FileSet();
        fs.setIncludes(Arrays.asList(relativeCustomIncludePath));
        mojo.iarFileSets = new FileSet[] { fs };

        mojo.execute();
        try (ZipFile archive = new ZipFile(mojo.project.getArtifact().getFile())) {
            assertThat(archive.getEntry(relativeCustomIncludePath)).as("Custom inclusions must be included")
                    .isNotNull();
        }
    }

    @Test
    public void canExcludeEmptyDirectories() throws Exception {
        IarPackagingMojo mojo = rule.getMojo();
        mojo.iarIncludesEmptyDirs = false;
        mojo.execute();

        try (ZipFile archive = new ZipFile(mojo.project.getArtifact().getFile())) {
            assertThat(archive.getEntry("src_hd")).as("Empty directory should be excluded by mojo configuration")
                    .isNull();
        }
    }

}