ProjectUtilTest.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.sling.ide.test.impl;

import static org.hamcrest.CoreMatchers.equalTo;
import static org.hamcrest.CoreMatchers.nullValue;
import static org.junit.Assert.assertThat;

import java.io.ByteArrayInputStream;

import org.apache.sling.ide.eclipse.core.ProjectUtil;
import org.apache.sling.ide.test.impl.helpers.ProjectAdapter;
import org.apache.sling.ide.test.impl.helpers.TemporaryProject;
import org.eclipse.core.resources.IFolder;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.runtime.QualifiedName;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;

public class ProjectUtilTest {

    @Rule
    public TemporaryProject projectRule = new TemporaryProject();
    
    private IProject contentProject;
    private ProjectAdapter project;

    @Before
    public void createEmptyContentProject() throws Exception {
        // create faceted project
        contentProject = projectRule.getProject();

        project = new ProjectAdapter(contentProject);
        project.addNatures("org.eclipse.wst.common.project.facet.core.nature");

        // install bundle facet
        project.installFacet("sling.content", "1.0");

        // create filter file
        project.createVltFilterWithRoots();
        // create content sync dir
        project.ensureDirectoryExists(Path.fromPortableString("jcr_root"));
    }
    
    @Test
    public void slingContentProjectSyncedResourcesAreExportable() throws CoreException, InterruptedException {


        project.createOrUpdateFile(Path.fromPortableString("jcr_root/test/hello.txt"), new ByteArrayInputStream(
                "goodbye, world".getBytes()));

        IPath filterPath = ProjectUtil.findFilterPath(contentProject);
        assertThat("filterPath.absolute", filterPath.isAbsolute(), equalTo(true));
        
        assertThat("filterPath", filterPath.makeRelativeTo(contentProject.getLocation()).toPortableString(),
                equalTo("META-INF/vault/filter.xml"));

    }
    
    @Test
    public void defaultContentSyncRootIsReturned() throws Exception {

        IFolder syncDirectory = ProjectUtil.getSyncDirectory(contentProject);
        
        assertThat(syncDirectory.getProjectRelativePath(), equalTo(Path.fromPortableString("jcr_root")));
    }
    
    @Test
    public void customContentSyncRootIsObeyed() throws Exception {
        
        IPath contentSyncPath = Path.fromPortableString("src/main/content/jcr_root");
        
        project.ensureDirectoryExists(contentSyncPath);
        ProjectUtil.setSyncDirectoryPath(contentProject, contentSyncPath);
        
        assertThat(ProjectUtil.getSyncDirectory(contentProject).getProjectRelativePath(), equalTo(contentSyncPath));
    }
    
    @Test
    public void oldContentSyncRootIsMigrated() throws Exception {

        QualifiedName oldPropertyQName = new QualifiedName("org.apache.sling.ide.eclipse-core", "sync_root");
        
        IPath contentSyncPath = Path.fromPortableString("src/main/content/jcr_root");
        
        project.ensureDirectoryExists(contentSyncPath);
        
        // simulate the old property being set
        contentProject.setPersistentProperty(oldPropertyQName, contentSyncPath.toString());
        
        // query the data through the API, old value should be obeyed
        assertThat("Old sync_root not obeyed", ProjectUtil.getSyncDirectory(contentProject).getProjectRelativePath(), equalTo(contentSyncPath));
        // the old store should no longer have the config value
        assertThat("Old property not removed", contentProject.getPersistentProperty(oldPropertyQName), nullValue());
        // a second query should work just the same, to make sure that after deleting the data from the old store we get the right value back
        assertThat("sync_root not obeyed after old store for property was deleted", 
                ProjectUtil.getSyncDirectory(contentProject).getProjectRelativePath(), equalTo(contentSyncPath));
    }
    
    @Test
    public void noModelsDirectory() throws Exception {
    	
    	assertThat("provisioning model path", ProjectUtil.getProvisioningModelPath(contentProject), nullValue());
    }

    @Test
    public void existingModelsDirectoryWithoutLaunchpadNature() throws Exception {

    	IPath modelPath = Path.fromPortableString("src/main/provisioning");
		project.ensureDirectoryExists(modelPath);
    	ProjectUtil.setProvisioningModelPath(contentProject, modelPath);
    	
    	assertThat("provisioning model path", ProjectUtil.getProvisioningModelPath(contentProject), nullValue());
    }

    @Test
    public void existingModelsDirectoryWithLaunchpadNature() throws Exception {
    	
    	project.installFacet("sling.launchpad", "1.0");
    	
    	IPath modelPath = Path.fromPortableString("src/main/provisioning");
    	project.ensureDirectoryExists(modelPath);
    	ProjectUtil.setProvisioningModelPath(contentProject, modelPath);
    	
    	assertThat("provisioning model path", ProjectUtil.getProvisioningModelPath(contentProject), equalTo(modelPath));
    }
}