implemented HookTagProvider api for mercurial

scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/api/HgHookBranchProvider.java

@@ -37,7 +37,7 @@ import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableList.Builder;
 
 import sonia.scm.repository.Changeset;
-import sonia.scm.repository.spi.HgHookChangesetProvider;
+import sonia.scm.repository.spi.HookChangesetProvider;
 import sonia.scm.repository.spi.HookChangesetRequest;
 import sonia.scm.repository.spi.javahg.AbstractChangesetCommand;
 import sonia.scm.util.Util;
@@ -46,38 +46,37 @@ import sonia.scm.util.Util;
 
 import java.util.List;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 /**
- *
+ * Mercurial hook branch provider implementation.
+ * 
  * @author Sebastian Sdorra
  */
 public class HgHookBranchProvider implements HookBranchProvider
 {
+  
+  private static final Logger logger = LoggerFactory.getLogger(HgHookBranchProvider.class);
 
-  /** Field description */
   private static final HookChangesetRequest REQUEST =
     new HookChangesetRequest();
 
   //~--- constructors ---------------------------------------------------------
 
   /**
-   * Constructs ...
+   * Constructs a new instance.
    *
    *
-   * @param changesetProvider
+   * @param changesetProvider changeset provider
    */
-  public HgHookBranchProvider(HgHookChangesetProvider changesetProvider)
+  public HgHookBranchProvider(HookChangesetProvider changesetProvider)
   {
     this.changesetProvider = changesetProvider;
   }
 
   //~--- get methods ----------------------------------------------------------
 
-  /**
-   * Method description
-   *
-   *
-   * @return
-   */
   @Override
   public List<String> getCreatedOrModified()
   {
@@ -89,12 +88,6 @@ public class HgHookBranchProvider implements HookBranchProvider
     return createdOrModified;
   }
 
-  /**
-   * Method description
-   *
-   *
-   * @return
-   */
   @Override
   public List<String> getDeletedOrClosed()
   {
@@ -108,15 +101,6 @@ public class HgHookBranchProvider implements HookBranchProvider
 
   //~--- methods --------------------------------------------------------------
 
-  /**
-   * Method description
-   *
-   *
-   * @param builder
-   * @param c
-   *
-   * @return
-   */
   private List<String> appendBranches(Builder<String> builder, Changeset c)
   {
     List<String> branches = c.getBranches();
@@ -133,26 +117,18 @@ public class HgHookBranchProvider implements HookBranchProvider
     return branches;
   }
 
-  /**
-   * Method description
-   *
-   *
-   * @return
-   */
   private Iterable<Changeset> changesets()
   {
     return changesetProvider.handleRequest(REQUEST).getChangesets();
   }
 
-  /**
-   * Method description
-   *
-   */
   private void collect()
   {
     Builder<String> createdOrModifiedBuilder = ImmutableList.builder();
     Builder<String> deletedOrClosedBuilder = ImmutableList.builder();
 
+    logger.trace("collecting branches from hook changesets");
+    
     for (Changeset c : changesets())
     {
       if (c.getProperty(AbstractChangesetCommand.PROPERTY_CLOSE) != null)
@@ -171,12 +147,9 @@ public class HgHookBranchProvider implements HookBranchProvider
 
   //~--- fields ---------------------------------------------------------------
 
-  /** Field description */
-  private final HgHookChangesetProvider changesetProvider;
+  private final HookChangesetProvider changesetProvider;
 
-  /** Field description */
   private List<String> createdOrModified;
 
-  /** Field description */
   private List<String> deletedOrClosed;
 }

scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/api/HgHookTagProvider.java

@@ -0,0 +1,107 @@
+/**
+ * *
+ * Copyright (c) 2015, Sebastian Sdorra
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 3. Neither the name of SCM-Manager; nor the names of its
+ *    contributors may be used to endorse or promote products derived from this
+ *    software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * https://bitbucket.org/sdorra/scm-manager
+ *
+ */
+package sonia.scm.repository.api;
+
+import com.google.common.collect.ImmutableList;
+import java.util.Collections;
+import java.util.List;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import sonia.scm.repository.Changeset;
+import sonia.scm.repository.Tag;
+import sonia.scm.repository.spi.HookChangesetProvider;
+import sonia.scm.repository.spi.HookChangesetRequest;
+import sonia.scm.repository.spi.HookChangesetResponse;
+
+/**
+ * Mercurial tag provider implementation.
+ *
+ * @author Sebastian Sdorra
+ * @since 1.50
+ */
+public class HgHookTagProvider implements HookTagProvider {
+
+  private static final Logger logger = LoggerFactory.getLogger(HgHookTagProvider.class);
+  
+  private static final HookChangesetRequest REQUEST = new HookChangesetRequest();
+
+  private final HookChangesetProvider changesetProvider;
+
+  private List<Tag> createdTags;
+  private final List<Tag> deletedTags = Collections.emptyList();
+
+  /**
+   * Constructs a new instance.
+   *
+   * @param changesetProvider changeset provider
+   */
+  public HgHookTagProvider(HookChangesetProvider changesetProvider) {
+    this.changesetProvider = changesetProvider;
+  }
+
+  @Override
+  public List<Tag> getCreatedTags() {
+    if (createdTags == null) {
+      collect();
+    }
+    return createdTags;
+  }
+
+  @Override
+  public List<Tag> getDeletedTags() {
+    logger.warn("detecting deleted tags with mercurial is currently not supported");
+    return deletedTags;
+  }
+
+  private void collect() {
+    ImmutableList.Builder<Tag> createdTagsBuilder = ImmutableList.builder();
+    
+    logger.trace("collecting tags from hook changesets");
+    HookChangesetResponse response = changesetProvider.handleRequest(REQUEST);
+    for ( Changeset c : response.getChangesets() ){
+      appendTags(createdTagsBuilder, c);
+    }
+    
+    createdTags = createdTagsBuilder.build();
+  }
+  
+  private void appendTags(ImmutableList.Builder<Tag> tags, Changeset c){
+    List<String> tagNames = c.getTags();
+    if (tagNames != null){
+      for ( String tagName : tagNames ){
+        logger.trace("found tag {} at changeset {}", tagName, c.getId());
+        tags.add(new Tag(tagName, c.getId()));
+      }
+    }
+  }
+
+}

scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/api/HgHookTagTest.java

@@ -0,0 +1,57 @@
+/***
+ * Copyright (c) 2015, Sebastian Sdorra
+ * All rights reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 3. Neither the name of SCM-Manager; nor the names of its
+ *    contributors may be used to endorse or promote products derived from this
+ *    software without specific prior written permission.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * 
+ * https://bitbucket.org/sdorra/scm-manager
+ * 
+ */
+
+package sonia.scm.repository.api;
+
+import com.google.common.eventbus.Subscribe;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import sonia.scm.EagerSingleton;
+import sonia.scm.plugin.ext.Extension;
+import sonia.scm.repository.PostReceiveRepositoryHookEvent;
+
+/**
+ *
+ * @author Sebastian Sdorra
+ */
+@Extension
+@EagerSingleton
+public class HgHookTagTest {
+
+  private static final Logger logger = LoggerFactory.getLogger(HgHookTagTest.class);
+  
+  @Subscribe
+  public void handle(PostReceiveRepositoryHookEvent event){
+    HookTagProvider tagProvider = event.getContext().getTagProvider();
+    logger.error("!!!! received mercurial tags {}", tagProvider.getCreatedTags());
+  }
+  
+}

scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgHookContextProvider.java

@@ -46,30 +46,31 @@ import sonia.scm.repository.api.HookMessageProvider;
 
 import java.util.EnumSet;
 import java.util.Set;
+import sonia.scm.repository.api.HgHookTagProvider;
+import sonia.scm.repository.api.HookTagProvider;
 
 /**
- *
+ * Mercurial implementation of {@link HookContextProvider}.
+ * 
  * @author Sebastian Sdorra
  */
 public class HgHookContextProvider extends HookContextProvider
 {
 
-  /** Field description */
   private static final Set<HookFeature> SUPPORTED_FEATURES =
     EnumSet.of(HookFeature.CHANGESET_PROVIDER, HookFeature.MESSAGE_PROVIDER,
-      HookFeature.BRANCH_PROVIDER);
+      HookFeature.BRANCH_PROVIDER, HookFeature.TAG_PROVIDER);
 
   //~--- constructors ---------------------------------------------------------
 
   /**
-   * Constructs ...
+   * Constructs a new instance.
    *
-   *
-   * @param handler
-   * @param repositoryName
-   * @param hookManager
-   * @param startRev
-   * @param type
+   * @param handler mercurial repository handler
+   * @param repositoryName name of changed repository
+   * @param hookManager mercurial hook manager
+   * @param startRev start revision
+   * @param type type of hook
    */
   public HgHookContextProvider(HgRepositoryHandler handler,
     String repositoryName, HgHookManager hookManager, String startRev,
@@ -81,12 +82,6 @@ public class HgHookContextProvider extends HookContextProvider
 
   //~--- get methods ----------------------------------------------------------
 
-  /**
-   * Method description
-   *
-   *
-   * @return
-   */
   @Override
   public HookBranchProvider getBranchProvider()
   {
@@ -98,24 +93,23 @@ public class HgHookContextProvider extends HookContextProvider
     return hookBranchProvider;
   }
 
-  /**
-   * Method description
-   *
-   *
-   * @return
-   */
+  @Override
+  public HookTagProvider getTagProvider() 
+  {
+    if (hookTagProvider == null)
+    {
+      hookTagProvider = new HgHookTagProvider(hookChangesetProvider);
+    }
+    
+    return hookTagProvider;
+  }
+
   @Override
   public HookChangesetProvider getChangesetProvider()
   {
     return hookChangesetProvider;
   }
-
-  /**
-   * Method description
-   *
-   *
-   * @return
-   */
+  
   public HgHookMessageProvider getHgMessageProvider()
   {
     if (hgMessageProvider == null)
@@ -126,12 +120,6 @@ public class HgHookContextProvider extends HookContextProvider
     return hgMessageProvider;
   }
 
-  /**
-   * Method description
-   *
-   *
-   * @return
-   */
   @Override
   public Set<HookFeature> getSupportedFeatures()
   {
@@ -140,12 +128,6 @@ public class HgHookContextProvider extends HookContextProvider
 
   //~--- methods --------------------------------------------------------------
 
-  /**
-   * Method description
-   *
-   *
-   * @return
-   */
   @Override
   protected HookMessageProvider createMessageProvider()
   {
@@ -154,12 +136,11 @@ public class HgHookContextProvider extends HookContextProvider
 
   //~--- fields ---------------------------------------------------------------
 
-  /** Field description */
   private final HgHookChangesetProvider hookChangesetProvider;
 
-  /** Field description */
   private HgHookMessageProvider hgMessageProvider;
 
-  /** Field description */
   private HgHookBranchProvider hookBranchProvider;
+  
+  private HgHookTagProvider hookTagProvider;
 }