org.sonar.batch.MavenProjectConverter.java Source code

Introduction

Here is the source code for org.sonar.batch.MavenProjectConverter.java

Source

/*
 * Sonar, open source software quality management tool.
 * Copyright (C) 2008-2012 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * Sonar 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 3 of the License, or (at your option) any later version.
 *
 * Sonar 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 Sonar; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
 */
package org.sonar.batch;

import java.io.File;
import java.io.IOException;
import java.util.List;
import java.util.Map;

import org.apache.maven.project.MavenProject;
import org.sonar.api.batch.bootstrap.ProjectDefinition;
import org.sonar.api.utils.SonarException;

import com.google.common.collect.Maps;

public final class MavenProjectConverter {

    private static final String UNABLE_TO_DETERMINE_PROJECT_STRUCTURE_EXCEPTION_MESSAGE = "Unable to determine structure of project."
            + " Probably you use Maven Advanced Reactor Options, which is not supported by Sonar and should not be used.";

    public static ProjectDefinition convert(List<MavenProject> poms, MavenProject root) {
        Map<String, MavenProject> paths = Maps.newHashMap(); // projects by canonical path to pom.xml
        Map<MavenProject, ProjectDefinition> defs = Maps.newHashMap();

        try {
            for (MavenProject pom : poms) {
                paths.put(pom.getFile().getCanonicalPath(), pom);
                defs.put(pom, convert(pom));
            }

            for (Map.Entry<String, MavenProject> entry : paths.entrySet()) {
                MavenProject pom = entry.getValue();
                for (Object m : pom.getModules()) {
                    String moduleId = (String) m;
                    File modulePath = new File(pom.getBasedir(), moduleId);
                    if (modulePath.exists() && modulePath.isDirectory()) {
                        modulePath = new File(modulePath, "pom.xml");
                    }
                    MavenProject module = paths.get(modulePath.getCanonicalPath());

                    ProjectDefinition parentProject = defs.get(pom);
                    ProjectDefinition subProject = defs.get(module);
                    if (parentProject == null) {
                        throw new IllegalStateException(UNABLE_TO_DETERMINE_PROJECT_STRUCTURE_EXCEPTION_MESSAGE);
                    }
                    if (subProject == null) {
                        throw new IllegalStateException(UNABLE_TO_DETERMINE_PROJECT_STRUCTURE_EXCEPTION_MESSAGE);
                    }
                    parentProject.addSubProject(subProject);
                }
            }
        } catch (IOException e) {
            throw new SonarException(e);
        }

        ProjectDefinition rootProject = defs.get(root);
        if (rootProject == null) {
            throw new IllegalStateException(UNABLE_TO_DETERMINE_PROJECT_STRUCTURE_EXCEPTION_MESSAGE);
        }

        return rootProject;
    }

    /**
     * Visibility has been relaxed for tests.
     */
    static ProjectDefinition convert(MavenProject pom) {
        String key = new StringBuilder().append(pom.getGroupId()).append(":").append(pom.getArtifactId())
                .toString();
        ProjectDefinition definition = ProjectDefinition.create();
        // IMPORTANT NOTE : reference on properties from POM model must not be saved, instead they should be copied explicitly - see SONAR-2896
        definition.setProperties(pom.getModel().getProperties()).setKey(key).setVersion(pom.getVersion())
                .setName(pom.getName()).setDescription(pom.getDescription()).addContainerExtension(pom);
        synchronizeFileSystem(pom, definition);
        return definition;
    }

    public static void synchronizeFileSystem(MavenProject pom, ProjectDefinition into) {
        into.setBaseDir(pom.getBasedir());
        into.setWorkDir(new File(resolvePath(pom.getBuild().getDirectory(), pom.getBasedir()), "sonar"));
        into.setSourceDirs(
                (String[]) pom.getCompileSourceRoots().toArray(new String[pom.getCompileSourceRoots().size()]));
        into.setTestDirs((String[]) pom.getTestCompileSourceRoots()
                .toArray(new String[pom.getTestCompileSourceRoots().size()]));
    }

    static File resolvePath(String path, File basedir) {
        File file = new File(path);
        if (!file.isAbsolute()) {
            try {
                file = new File(basedir, path).getCanonicalFile();
            } catch (IOException e) {
                throw new SonarException("Unable to resolve path '" + path + "'", e);
            }
        }
        return file;
    }

    private MavenProjectConverter() {
        // only static methods
    }
}