buildframework/helium/sf/java/scm/src/com/nokia/helium/scm/ant/actions/CheckoutAction.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
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    20
import java.util.ArrayList;
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    21
import java.util.List;
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    22
588
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    23
import org.apache.maven.scm.ScmException;
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    24
import org.apache.maven.scm.ScmRevision;
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    25
import org.apache.maven.scm.ScmTag;
588
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    26
import org.apache.maven.scm.command.checkout.CheckOutScmResult;
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
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    31
import com.nokia.helium.scm.ant.types.Revision;
588
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    32
import com.nokia.helium.scm.ant.types.Tag;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    33
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    34
/**
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    35
 * Checkout the defined project. Depending on the kind of repository used this
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    36
 * can mean for example the cloning of a repository in the case of Mercurial or the copying of 
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    37
 * a repository in the case of SVN.
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    38
 *
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    39
 * <pre>
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    40
 * &lt;hlm:scm verbose="true" scmUrl="scm:${repo.type}:${repo.dir}/test3"&gt;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    41
 *     &lt;hlm:checkout baseDir="${repo.dir}/cloned" /&gt;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    42
 * &lt;/hlm:scm&gt;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    43
 * </pre>
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    44
 *
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    45
 * @ant.type name="checkout" category="SCM"
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    46
 */
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    47
public class CheckoutAction extends BaseDirectoryScmAction {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    48
    private List<Tag> tags = new ArrayList<Tag>();
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    49
    private List<Revision> revisions = new ArrayList<Revision>();
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    50
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    51
    public Tag createTag() {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    52
        Tag tag = new Tag();
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    53
        add(tag);
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    54
        return tag;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    55
    }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    56
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    57
    public void add(Tag tag) {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    58
        tags.add(tag);
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    59
    }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    60
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    61
    public Revision createRevision() {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    62
        Revision revision = new Revision();
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    63
        add(revision);
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    64
        return revision;
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
    public void add(Revision revision) {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    68
        revisions.add(revision);
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    69
    }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    70
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    71
    @Override
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    72
    public void execute(ScmRepository repository) throws ScmException {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    73
        ScmManager scmManager = getTask().getScmManager();
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    74
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    75
        if (tags.size() > 1) {
588
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    76
            throw new ScmException(
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    77
                    "You can only specify one tag nested element.");
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    78
        }
588
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    79
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    80
        if (revisions.size() > 1) {
588
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    81
            throw new ScmException(
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    82
                    "You can only specify one revision nested element.");
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    83
        }
588
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    84
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    85
        if ((tags.size() == 1) && (revisions.size() == 1)) {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    86
            throw new ScmException(
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    87
                    "You can not specify nested element 'revision' and 'tag' together.");
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    88
        }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    89
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    90
        CheckOutScmResult result;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    91
        try {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    92
            if (tags.size() == 1) {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    93
                result = scmManager.checkOut(repository, getScmFileSet(),
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    94
                        new ScmTag(tags.get(0).getName()));
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    95
            } else if (revisions.size() == 1) {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    96
                result = scmManager.checkOut(repository, getScmFileSet(),
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    97
                        new ScmRevision(revisions.get(0).getName()));
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    98
            } else {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    99
                result = scmManager.checkOut(repository, getScmFileSet());
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   100
            }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   101
        } catch (ScmException e) {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   102
            throw new BuildException("SCM checkout action failed: " + e);
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   103
        }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   104
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   105
        if (!result.isSuccess()) {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   106
            throw new BuildException("SCM checkout action failed.");
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   107
        }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   108
    }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   109
}