Bit of formatting and commented code removal

pvdissel · pvdissel · commit 4c685caf586f · 2013-09-14T17:37:26.000+02:00
diff --git a/src/main/groovy/org/pipelinelabs/pipeline/cli/dsl/PipelineScriptRunner.java b/src/main/groovy/org/pipelinelabs/pipeline/cli/dsl/PipelineScriptRunner.java
@@ -1,10 +1,9 @@
 package org.pipelinelabs.pipeline.cli.dsl;
 
 import groovy.lang.GroovyShell;
+import org.codehaus.groovy.control.CompilerConfiguration;
 import org.pipelinelabs.pipeline.cli.dsl.script.PipelineScript;
 import org.pipelinelabs.pipeline.dsl.PipelineDsl;
-import org.pipelinelabs.pipeline.dsl.internal.DefaultPipelineDsl;
-import org.codehaus.groovy.control.CompilerConfiguration;
 import org.pipelinelabs.pipeline.internal.ServiceRegistry;
 
 import java.io.PrintStream;
diff --git a/src/main/groovy/org/pipelinelabs/pipeline/dsl/AnnounceDsl.java b/src/main/groovy/org/pipelinelabs/pipeline/dsl/AnnounceDsl.java
@@ -1,12 +1,12 @@
 package org.pipelinelabs.pipeline.dsl;
 
-import java.util.List;
-
 import groovy.lang.Closure;
-
 import org.pipelinelabs.pipeline.messenger.MessageContext;
 
+import java.util.List;
+
 public interface AnnounceDsl {
     void email(Closure config);
+
     List<MessageContext> toContexts();
 }
diff --git a/src/main/groovy/org/pipelinelabs/pipeline/dsl/EmailDsl.java b/src/main/groovy/org/pipelinelabs/pipeline/dsl/EmailDsl.java
@@ -1,14 +1,21 @@
 package org.pipelinelabs.pipeline.dsl;
 
-import java.util.List;
 import org.pipelinelabs.pipeline.messenger.internal.EmailContext;
 
+import java.util.List;
+
 public interface EmailDsl extends MessageContextDsl<EmailContext> {
     List<String> getTo();
+
     void to(String... to);
+
     void setTo(List<String> to);
+
     List<String> getCc();
+
     void cc(String... cc);
+
     void setCc(List<String> cc);
+
     EmailContext toContext();
 }
diff --git a/src/main/groovy/org/pipelinelabs/pipeline/dsl/EmailMessengerDsl.java b/src/main/groovy/org/pipelinelabs/pipeline/dsl/EmailMessengerDsl.java
@@ -4,16 +4,28 @@
 
 public interface EmailMessengerDsl {
     String getHost();
+
     void setHost(String host);
+
     int getPort();
+
     void setPort(int port);
+
     boolean getTls();
+
     void setTls(boolean tls);
+
     String getUsername();
+
     void setUsername(String username);
+
     String getPassword();
+
     void setPassword(String password);
+
     String getFrom();
+
     void setFrom(String from);
+
     EmailMessenger toMessenger();
 }
diff --git a/src/main/groovy/org/pipelinelabs/pipeline/dsl/MessengerDsl.java b/src/main/groovy/org/pipelinelabs/pipeline/dsl/MessengerDsl.java
@@ -1,10 +1,10 @@
 package org.pipelinelabs.pipeline.dsl;
 
 import groovy.lang.Closure;
-
 import org.pipelinelabs.pipeline.messenger.Messenger;
 
 public interface MessengerDsl {
     void email(Closure config);
+
     Messenger toMessenger();
 }
diff --git a/src/main/groovy/org/pipelinelabs/pipeline/dsl/PipelineDsl.java b/src/main/groovy/org/pipelinelabs/pipeline/dsl/PipelineDsl.java
@@ -9,11 +9,7 @@ public interface PipelineDsl {
 
     void echo(String format, Object... values);
 
-    // MessengerDsl getMessenger();
-
     MessengerDsl messenger(Closure closure);
 
-    // AnnounceDsl getAnnounce();
-
     AnnounceDsl announce(Closure closure);
 }
diff --git a/src/main/groovy/org/pipelinelabs/pipeline/dsl/internal/DefaultAnnounceDsl.groovy b/src/main/groovy/org/pipelinelabs/pipeline/dsl/internal/DefaultAnnounceDsl.groovy
@@ -2,7 +2,6 @@ package org.pipelinelabs.pipeline.dsl.internal
 
 import org.pipelinelabs.pipeline.dsl.AnnounceDsl
 import org.pipelinelabs.pipeline.dsl.EmailDsl
-import org.pipelinelabs.pipeline.dsl.internal.DefaultEmailDsl
 import org.pipelinelabs.pipeline.messenger.MessageContext
 import org.pipelinelabs.pipeline.util.ConfigureUtil
 
diff --git a/src/main/groovy/org/pipelinelabs/pipeline/dsl/internal/DefaultMessengerDsl.groovy b/src/main/groovy/org/pipelinelabs/pipeline/dsl/internal/DefaultMessengerDsl.groovy
@@ -1,10 +1,9 @@
 package org.pipelinelabs.pipeline.dsl.internal
 
+import org.pipelinelabs.pipeline.dsl.EmailMessengerDsl
+import org.pipelinelabs.pipeline.dsl.MessengerDsl
 import org.pipelinelabs.pipeline.messenger.Messenger
 import org.pipelinelabs.pipeline.messenger.internal.AggregateMessenger
-import org.pipelinelabs.pipeline.dsl.MessengerDsl
-import org.pipelinelabs.pipeline.dsl.EmailMessengerDsl
-import org.pipelinelabs.pipeline.dsl.internal.DefaultEmailMessengerDsl
 import org.pipelinelabs.pipeline.util.ConfigureUtil
 
 class DefaultMessengerDsl implements MessengerDsl {
diff --git a/src/main/groovy/org/pipelinelabs/pipeline/dsl/internal/DefaultPipelineDsl.java b/src/main/groovy/org/pipelinelabs/pipeline/dsl/internal/DefaultPipelineDsl.java
@@ -11,8 +11,8 @@
 import org.pipelinelabs.pipeline.runner.DefaultPipeline;
 import org.pipelinelabs.pipeline.util.ConfigureUtil;
 
-import java.util.LinkedHashSet;
 import java.util.ArrayList;
+import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Set;
 
@@ -55,11 +55,6 @@ public Pipeline export() {
         return pipeline;
     }
 
-    // @Override
-    // public AnnounceDsl getAnnounce() {
-    //     return announce;
-    // }
-
     @Override
     public AnnounceDsl announce(Closure closure) {
         ConfigureUtil.configure(announce, closure);
@@ -71,11 +66,6 @@ public AnnounceDsl announce(Closure closure) {
         return announce;
     }
 
-    // @Override
-    // public MessengerDsl getMessenger() {
-    //     return messenger;
-    // }
-
     @Override
     public MessengerDsl messenger(Closure closure) {
         ConfigureUtil.configure(messenger, closure);
diff --git a/src/main/groovy/org/pipelinelabs/pipeline/dsl/internal/DefaultStageDsl.java b/src/main/groovy/org/pipelinelabs/pipeline/dsl/internal/DefaultStageDsl.java
@@ -1,12 +1,12 @@
 package org.pipelinelabs.pipeline.dsl.internal;
 
-import org.pipelinelabs.pipeline.api.Stage;
-import org.pipelinelabs.pipeline.exception.PipelineException;
-import org.pipelinelabs.pipeline.runner.DefaultStage;
 import org.apache.maven.shared.utils.cli.CommandLineException;
 import org.apache.maven.shared.utils.cli.CommandLineUtils;
 import org.apache.maven.shared.utils.cli.Commandline;
 import org.apache.maven.shared.utils.cli.WriterStreamConsumer;
+import org.pipelinelabs.pipeline.api.Stage;
+import org.pipelinelabs.pipeline.exception.PipelineException;
+import org.pipelinelabs.pipeline.runner.DefaultStage;
 
 import java.io.BufferedWriter;
 import java.io.OutputStreamWriter;
diff --git a/src/main/groovy/org/pipelinelabs/pipeline/internal/ServiceRegistry.java b/src/main/groovy/org/pipelinelabs/pipeline/internal/ServiceRegistry.java
@@ -11,7 +11,8 @@ public interface ServiceRegistry {
      * @param <T>         The service type.
      * @return The service instance. Never returns null.
      * @throws UnknownServiceException When there is no service of the given type available.
-     * @throws org.pipelinelabs.pipeline.cli.ServiceLookupException  On failure to lookup the specified service.
+     * @throws org.pipelinelabs.pipeline.cli.ServiceLookupException
+     *                                 On failure to lookup the specified service.
      */
     <T> T get(Class<T> serviceType) throws ServiceLookupException;
 }
diff --git a/src/main/groovy/org/pipelinelabs/pipeline/messenger/internal/AggregateMessenger.java b/src/main/groovy/org/pipelinelabs/pipeline/messenger/internal/AggregateMessenger.java
@@ -1,9 +1,9 @@
 package org.pipelinelabs.pipeline.messenger.internal;
 
+import org.pipelinelabs.pipeline.event.PipeEvent;
+import org.pipelinelabs.pipeline.messenger.MessageContext;
 import org.pipelinelabs.pipeline.messenger.Messenger;
 import org.pipelinelabs.pipeline.messenger.SpecializedMessenger;
-import org.pipelinelabs.pipeline.messenger.MessageContext;
-import org.pipelinelabs.pipeline.event.PipeEvent;
 
 public class AggregateMessenger implements Messenger {
     private final Iterable<? extends SpecializedMessenger> messengers;
diff --git a/src/main/groovy/org/pipelinelabs/pipeline/messenger/internal/EmailContext.java b/src/main/groovy/org/pipelinelabs/pipeline/messenger/internal/EmailContext.java
@@ -1,10 +1,10 @@
 package org.pipelinelabs.pipeline.messenger.internal;
 
+import org.pipelinelabs.pipeline.messenger.MessageContext;
+
 import java.util.Collections;
 import java.util.List;
 
-import org.pipelinelabs.pipeline.messenger.MessageContext;
-
 public class EmailContext implements MessageContext {
     private final List<String> to;
     private final List<String> cc;
diff --git a/src/main/groovy/org/pipelinelabs/pipeline/messenger/internal/EmailMessenger.java b/src/main/groovy/org/pipelinelabs/pipeline/messenger/internal/EmailMessenger.java
@@ -1,14 +1,13 @@
 package org.pipelinelabs.pipeline.messenger.internal;
 
-import javax.mail.MessagingException;
-import javax.mail.internet.MimeMessage;
-
+import org.pipelinelabs.pipeline.event.PipeEvent;
+import org.pipelinelabs.pipeline.messenger.MessageContext;
+import org.pipelinelabs.pipeline.messenger.SpecializedMessenger;
 import org.springframework.mail.javamail.JavaMailSender;
 import org.springframework.mail.javamail.MimeMessageHelper;
 
-import org.pipelinelabs.pipeline.messenger.SpecializedMessenger;
-import org.pipelinelabs.pipeline.messenger.MessageContext;
-import org.pipelinelabs.pipeline.event.PipeEvent;
+import javax.mail.MessagingException;
+import javax.mail.internet.MimeMessage;
 
 public class EmailMessenger implements SpecializedMessenger {
     private final JavaMailSender sender;
diff --git a/src/test/groovy/org/pipelinelabs/pipeline/dsl/internal/DefaultPipelineDslSpec.groovy b/src/test/groovy/org/pipelinelabs/pipeline/dsl/internal/DefaultPipelineDslSpec.groovy
@@ -49,5 +49,4 @@ class DefaultPipelineDslSpec extends Specification {
         then:
         thrown(MissingMethodException)
     }
-
-}
+}
diff --git a/src/test/groovy/org/pipelinelabs/pipeline/messenger/internal/AggregateMessengerSpec.groovy b/src/test/groovy/org/pipelinelabs/pipeline/messenger/internal/AggregateMessengerSpec.groovy
@@ -1,11 +1,9 @@
 package org.pipelinelabs.pipeline.messenger.internal
 
-import spock.lang.Specification
-
 import org.pipelinelabs.pipeline.event.PipeEvent
 import org.pipelinelabs.pipeline.messenger.MessageContext
-import org.pipelinelabs.pipeline.messenger.Messenger
 import org.pipelinelabs.pipeline.messenger.SpecializedMessenger
+import spock.lang.Specification
 
 class AggregateMessengerSpec extends Specification {
     MessageContext context = Mock()
@@ -36,22 +34,22 @@ class AggregateMessengerSpec extends Specification {
 
     def 'only messengers that accept context process the event'() {
         given:
-         def messenger1 = Mock(SpecializedMessenger)
-         def messenger2 = Mock(SpecializedMessenger)
-         def messenger3 = Mock(SpecializedMessenger)
-         def messenger4 = Mock(SpecializedMessenger)
-         def aggregate = new AggregateMessenger([messenger1, messenger2,
-            messenger3, messenger4])
-         when:
-         aggregate.process(context, event)
-         then:
-         1 * messenger1.accepts(context) >> false
-         1 * messenger2.accepts(context) >> true
-         1 * messenger3.accepts(context) >> true
-         1 * messenger4.accepts(context) >> false
-         0 * messenger1.process(_, _)
-         1 * messenger2.process(context, event)
-         1 * messenger3.process(context, event)
-         0 * messenger4.process(_, _)
+        def messenger1 = Mock(SpecializedMessenger)
+        def messenger2 = Mock(SpecializedMessenger)
+        def messenger3 = Mock(SpecializedMessenger)
+        def messenger4 = Mock(SpecializedMessenger)
+        def aggregate = new AggregateMessenger([messenger1, messenger2,
+                messenger3, messenger4])
+        when:
+        aggregate.process(context, event)
+        then:
+        1 * messenger1.accepts(context) >> false
+        1 * messenger2.accepts(context) >> true
+        1 * messenger3.accepts(context) >> true
+        1 * messenger4.accepts(context) >> false
+        0 * messenger1.process(_, _)
+        1 * messenger2.process(context, event)
+        1 * messenger3.process(context, event)
+        0 * messenger4.process(_, _)
     }
 }
diff --git a/src/test/groovy/org/pipelinelabs/pipeline/messenger/internal/EmailMessengerSpec.groovy b/src/test/groovy/org/pipelinelabs/pipeline/messenger/internal/EmailMessengerSpec.groovy
@@ -1,17 +1,13 @@
 package org.pipelinelabs.pipeline.messenger.internal
 
-import javax.mail.Session
-import javax.mail.internet.MimeMessage
-import javax.mail.Message.RecipientType
-
-import spock.lang.Specification
-
-import org.springframework.mail.javamail.JavaMailSender
-
 import org.pipelinelabs.pipeline.event.PipeEvent
 import org.pipelinelabs.pipeline.messenger.MessageContext
-import org.pipelinelabs.pipeline.messenger.Messenger
-import org.pipelinelabs.pipeline.messenger.SpecializedMessenger
+import org.springframework.mail.javamail.JavaMailSender
+import spock.lang.Specification
+
+import javax.mail.Message.RecipientType
+import javax.mail.Session
+import javax.mail.internet.MimeMessage
 
 class EmailMessengerSpec extends Specification {
 
@@ -28,34 +24,37 @@ class EmailMessengerSpec extends Specification {
     def 'process generates the correct email'() {
         given:
         PipeEvent event = new PipeEvent(
-            'MyProject',
-            'Success',
-            'Gradle build succeeded in 10 seconds.',
-            'a bunch of\nlog data\n')
+                'MyProject',
+                'Success',
+                'Gradle build succeeded in 10 seconds.',
+                'a bunch of\nlog data\n')
         def from = '1@2.com'
         def to = ['a@b.com', 'c@d.com']
         def cc = ['e@f.com']
         EmailContext context = new EmailContext(to, cc)
+
         def email = new MimeMessage(null as Session)
         def sender = Mock(JavaMailSender)
         def messenger = new EmailMessenger(sender, from)
+
         when:
         messenger.process(context, event)
+
         then:
         1 * sender.createMimeMessage() >> { email }
-        1 * sender.send({ msg ->
+        1 * sender.send({ MimeMessage msg ->
             msg.from.collect { it as String } == [from] &&
-                msg.getRecipients(RecipientType.TO).collect { it as String } == to &&
-                msg.getRecipients(RecipientType.CC).collect { it as String } == cc &&
-                msg.subject == '[pipeline] MyProject: Success' &&
-                msg.content == """\
-Pipeline Name: MyProject
-Status:        Success
-Description:   Gradle build succeeded in 10 seconds.
-Details:
-a bunch of
-log data
-"""
-        })
+                    msg.getRecipients(RecipientType.TO).collect { it as String } == to &&
+                    msg.getRecipients(RecipientType.CC).collect { it as String } == cc &&
+                    msg.subject == '[pipeline] MyProject: Success' &&
+                    msg.content == """\
+                        Pipeline Name: MyProject
+                        Status:        Success
+                        Description:   Gradle build succeeded in 10 seconds.
+                        Details:
+                        a bunch of
+                        log data
+                        """.stripIndent()
+        } as MimeMessage)
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -9,11 +9,7 @@ public interface PipelineDsl {`
`9`	`9`
`10`	`10`	`void echo(String format, Object... values);`
`11`	`11`
`12`		`- // MessengerDsl getMessenger();`
`13`		`-`
`14`	`12`	`MessengerDsl messenger(Closure closure);`
`15`	`13`
`16`		`- // AnnounceDsl getAnnounce();`
`17`		`-`
`18`	`14`	`AnnounceDsl announce(Closure closure);`
`19`	`15`	`}`