buildframework/helium/sf/java/scm/src/com/nokia/helium/scm/ant/actions/ExportAction.java
author wbernard
Fri, 13 Aug 2010 14:59:05 +0300
changeset 628 7c4a911dc066
parent 588 c7c26511138f
permissions -rw-r--r--
helium_11.0.0-e00f171ca185
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
588
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
     1
/*
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
     2
 * Copyright (c) 2007-2008 Nokia Corporation and/or its subsidiary(-ies).
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
     3
 * All rights reserved.
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
     4
 * This component and the accompanying materials are made available
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
     5
 * under the terms of the License "Eclipse Public License v1.0"
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
     6
 * which accompanies this distribution, and is available
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
     7
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
     8
 *
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
     9
 * Initial Contributors:
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    10
 * Nokia Corporation - initial contribution.
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    11
 *
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    12
 * Contributors:
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    13
 *
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    14
 * Description:  
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    15
 *
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    16
 */
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    17
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    18
package com.nokia.helium.scm.ant.actions;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    19
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    20
import java.io.File;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    21
import java.util.ArrayList;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    22
import java.util.List;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    23
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    24
import org.apache.maven.scm.ScmException;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    25
import org.apache.maven.scm.ScmTag;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    26
import org.apache.maven.scm.command.export.ExportScmResult;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    27
import org.apache.maven.scm.manager.ScmManager;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    28
import org.apache.maven.scm.repository.ScmRepository;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    29
import org.apache.tools.ant.BuildException;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    30
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    31
import com.nokia.helium.scm.ant.types.Tag;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    32
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    33
/**
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    34
 * Get a snapshot of a particular revision into a folder.
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    35
 *
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    36
 * <pre>
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    37
 * &lt;hlm:scm verbose="true" scmUrl="scm:${repo.type}:${repo.dir}/test2"&gt;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    38
 *    &lt;hlm:export basedir="${repo.dir}/test2" destpath="${repo.dir}/export" /&gt;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    39
 * &lt;/hlm:scm&gt;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    40
 * </pre>
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    41
 *
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    42
 * @ant.type name="export" category="SCM"
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    43
 */
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    44
public class ExportAction extends BaseDirectoryScmAction {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    45
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    46
    private File destPath;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    47
    private List<Tag> tags = new ArrayList<Tag>();
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    48
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    49
    /**
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    50
     * Create a tag sub-element.
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    51
     * @return the tag element.
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    52
     */
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    53
    public Tag createTag() {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    54
        Tag tag = new Tag();
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    55
        add(tag);
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    56
        return tag;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    57
    }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    58
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    59
    /**
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    60
     * Add a tag.
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    61
     * @param tag
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    62
     */
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    63
    public void add(Tag tag) {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    64
        tags.add(tag);
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    65
    }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    66
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    67
    /**
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    68
     * {@inheritDoc}
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    69
     */
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    70
    @Override
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    71
    public void execute(ScmRepository repository) throws ScmException {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    72
        ScmManager scmManager = getTask().getScmManager();
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    73
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    74
        if (getDestPath() == null) {
588
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    75
            throw new ScmException("destPath attribute has not been provided.");
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    76
        }
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    77
        
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    78
        if (tags.size() > 1) {
588
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    79
            throw new ScmException(
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    80
                    "You can only specify one tag nested element.");
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    81
        }
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    82
        
588
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    83
        ExportScmResult result;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    84
        try {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    85
            if (tags.size() == 0) {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    86
                getTask().log(
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    87
                        "Exporting " + getScmFileSet().getBasedir() + " under "
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    88
                                + getDestPath().getAbsolutePath() + ".");
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    89
                result = scmManager.export(repository, getScmFileSet(),
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    90
                        getDestPath().getAbsolutePath());
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    91
            } else {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    92
                String tagName = tags.get(0).getName();
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    93
                getTask().log(
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    94
                        "Exporting revision " + tagName + " of "
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    95
                                + getScmFileSet().getBasedir() + " under "
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    96
                                + getDestPath().getAbsolutePath() + ".");
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    97
                result = scmManager.export(repository, getScmFileSet(),
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    98
                        new ScmTag(tagName), getDestPath().getAbsolutePath());
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    99
            }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   100
        } catch (ScmException e) {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   101
            throw new BuildException("SCM export action failed: " + e);
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   102
        }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   103
        if (!result.isSuccess()) {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   104
            throw new BuildException("SCM export action failed: "
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   105
                    + result.getProviderMessage());
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   106
        }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   107
        // Dump created files.
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   108
        for (Object file : result.getExportedFiles().toArray()) {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   109
            getTask().log(file.toString());
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   110
        }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   111
    }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   112
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   113
    public File getDestPath() {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   114
        return destPath;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   115
    }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   116
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   117
    public void setDestPath(File destPath) {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   118
        this.destPath = destPath;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   119
    }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   120
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   121
}