org.xwiki.environment.internal.ServletEnvironmentTest.java Source code

Introduction

Here is the source code for org.xwiki.environment.internal.ServletEnvironmentTest.java

Source

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.environment.internal;

import java.io.File;
import java.net.MalformedURLException;

import javax.servlet.ServletContext;

import org.apache.commons.io.FileUtils;
import org.junit.*;
import org.slf4j.Logger;
import org.xwiki.component.embed.EmbeddableComponentManager;
import org.xwiki.component.util.ReflectionUtils;
import org.xwiki.environment.Environment;
import org.xwiki.test.AllLogRule;

import static org.junit.Assert.*;
import static org.mockito.Mockito.*;

/**
 * Unit tests for {@link ServletEnvironment}.
 *
 * @version $Id: 4187b1e6873b320eb7d497ac6a3010ec98258019 $
 * @since 3.5M1
 */
public class ServletEnvironmentTest {
    private File servletTmpDir;

    private File systemTmpDir;

    private ServletEnvironment environment;

    /**
     * Capture logs.
     */
    @Rule
    public AllLogRule logRule = new AllLogRule();

    @Before
    public void setUp() throws Exception {
        this.servletTmpDir = new File(System.getProperty("java.io.tmpdir"), "ServletEnvironmentTest-tmpDir");
        this.systemTmpDir = new File(System.getProperty("java.io.tmpdir"), "xwiki-temp");

        EmbeddableComponentManager ecm = new EmbeddableComponentManager();
        ecm.initialize(getClass().getClassLoader());
        this.environment = ecm.getInstance(Environment.class);
    }

    @After
    public void tearDown() throws Exception {
        FileUtils.deleteQuietly(this.servletTmpDir);
    }

    @Test
    public void getResourceWhenServletContextNotSet() {
        try {
            this.environment.getResource("/whatever");
            fail();
        } catch (RuntimeException expected) {
            assertEquals("The Servlet Environment has not been properly initialized "
                    + "(The Servlet Context is not set)", expected.getMessage());
        }
    }

    @Test
    public void getResourceOk() throws Exception {
        ServletContext servletContext = mock(ServletContext.class);
        this.environment.setServletContext(servletContext);
        this.environment.getResource("/test");

        verify(servletContext).getResource("/test");
    }

    @Test
    public void getResourceAsStreamOk() throws Exception {
        ServletContext servletContext = mock(ServletContext.class);
        this.environment.setServletContext(servletContext);
        this.environment.getResourceAsStream("/test");

        verify(servletContext).getResourceAsStream("/test");
    }

    @Test
    public void getResourceNotExisting() throws Exception {
        ServletContext servletContext = mock(ServletContext.class);
        this.environment.setServletContext(servletContext);
        assertNull(this.environment.getResource("unknown resource"));
    }

    @Test
    public void getResourceWhenMalformedURLException() throws Exception {
        ServletContext servletContext = mock(ServletContext.class);
        when(servletContext.getResource("bad resource")).thenThrow(new MalformedURLException("invalid url"));
        this.environment.setServletContext(servletContext);
        assertNull(this.environment.getResource("bad resource"));
        assertEquals("Error getting resource [bad resource] because of invalid path format. Reason: [invalid url]",
                this.logRule.getMessage(0));
    }

    @Test
    public void getPermanentDirectoryWhenSetWithAPI() throws Exception {
        File permanentDirectory = new File("/permanent");
        this.environment.setPermanentDirectory(permanentDirectory);
        assertEquals(permanentDirectory.getCanonicalFile(),
                this.environment.getPermanentDirectory().getCanonicalFile());
    }

    @Test
    public void getPermanentDirectoryWhenSetWithSystemProperty() throws Exception {
        File expectedPermanentDirectory = new File(System.getProperty("java.io.tmpdir"), "permanent");
        System.setProperty("xwiki.data.dir", expectedPermanentDirectory.toString());

        try {
            this.environment.setServletContext(mock(ServletContext.class));

            assertEquals(expectedPermanentDirectory.getCanonicalFile(),
                    this.environment.getPermanentDirectory().getCanonicalFile());
        } finally {
            System.clearProperty("xwiki.data.dir");
        }
    }

    @Test
    public void getPermanentDirectoryWhenNotSet() throws Exception {
        ServletContext servletContext = mock(ServletContext.class);
        when(servletContext.getAttribute("javax.servlet.context.tempdir")).thenReturn(this.servletTmpDir);
        this.environment.setServletContext(servletContext);

        Logger logger = mock(Logger.class);
        ReflectionUtils.setFieldValue(this.environment, "logger", logger);

        assertEquals(this.servletTmpDir.getCanonicalFile(),
                this.environment.getPermanentDirectory().getCanonicalFile());

        // Also verify that we log a warning!
        verify(logger).warn("No permanent directory configured. Using temporary directory [{}].",
                this.servletTmpDir.getCanonicalFile());
    }

    @Test
    public void getTemporaryDirectory() throws Exception {
        File tmpDir = new File("tmpdir");
        this.environment.setTemporaryDirectory(tmpDir);
        assertEquals(tmpDir.getCanonicalFile(), this.environment.getTemporaryDirectory().getCanonicalFile());
    }

    @Test
    public void getTemporaryDirectoryWhenNotSet() throws Exception {
        ServletContext servletContext = mock(ServletContext.class);
        when(servletContext.getAttribute("javax.servlet.context.tempdir")).thenReturn(this.servletTmpDir);
        this.environment.setServletContext(servletContext);

        File tmpDir = this.environment.getTemporaryDirectory();

        // Make sure it is the "xwiki-temp" dir which is under the main temp dir.
        assertEquals(this.servletTmpDir.listFiles()[0].getCanonicalFile(), tmpDir.getCanonicalFile());
    }

    /**
     * Verify we default to the system tmp dir if the Servlet tmp dir is not set.
     */
    @Test
    public void getTemporaryDirectoryWhenServletTempDirNotSet() throws Exception {
        ServletContext servletContext = mock(ServletContext.class);
        this.environment.setServletContext(servletContext);

        assertEquals(this.systemTmpDir.getCanonicalFile(),
                this.environment.getTemporaryDirectory().getCanonicalFile());

        // Verify that servletContext.getAttribute was called (and that we returned null - this happens because we
        // didn't set any stubbing on servletContext and null is the default returned by Mockito).
        verify(servletContext).getAttribute("javax.servlet.context.tempdir");
    }
}