Merge branch '__rultor'

pom.xml

@@ -828,7 +828,7 @@ OF THE POSSIBILITY OF SUCH DAMAGE.
           <plugin>
             <groupId>com.qulice</groupId>
             <artifactId>qulice-maven-plugin</artifactId>
-            <version>0.22.1</version>
+            <version>0.22.2</version>
             <configuration>
               <excludes combine.children="append">
                 <exclude>checkstyle:/src/main/js/.*</exclude>

src/main/java/com/rultor/agents/daemons/ArchivesDaemon.java

@@ -46,7 +46,6 @@
 import java.nio.file.Files;
 import java.util.Date;
 import java.util.logging.Level;
-import javax.ws.rs.core.MediaType;
 import lombok.EqualsAndHashCode;
 import lombok.ToString;
 import org.apache.commons.io.FileUtils;
@@ -132,7 +131,7 @@ public Iterable<Directive> process(final XML xml) throws IOException {
      */
     private URI upload(final File file, final String hash) throws IOException {
         final ObjectMetadata meta = new ObjectMetadata();
-        meta.setContentType(MediaType.TEXT_PLAIN);
+        meta.setContentType("text/plain");
         meta.setContentEncoding(StandardCharsets.UTF_8.name());
         meta.setContentLength(file.length());
         final String key = String.format("%tY/%1$tm/%s.txt", new Date(), hash);

src/main/java/com/rultor/agents/github/CommitsLog.java

@@ -84,7 +84,7 @@ final class CommitsLog {
      * @return Release body text.
      * @throws IOException In case of problem communicating with git.
      */
-    @SuppressWarnings("PMD.UseConcurrentHashMap")
+    @SuppressWarnings({"PMD.UseConcurrentHashMap", "PMD.UseDiamondOperator"})
     public String build(final Date prev, final Date current)
         throws IOException {
         final DateFormat format = new SimpleDateFormat(

src/main/java/com/rultor/agents/shells/PfShell.java

@@ -33,7 +33,6 @@
 import com.jcabi.ssh.Ssh;
 import com.rultor.spi.Profile;
 import java.io.IOException;
-import java.io.InputStream;
 import java.net.UnknownHostException;
 import java.nio.charset.StandardCharsets;
 import lombok.EqualsAndHashCode;
@@ -151,8 +150,7 @@ public String key() throws IOException {
         if (path.isEmpty()) {
             key = this.pvt;
         } else {
-            final InputStream asset = this.profile.assets().get(path);
-            if (asset == null) {
+            if (this.profile.assets().get(path) == null) {
                 throw new Profile.ConfigException(
                     String.format("Private SSH key not found at %s", path)
                 );

src/main/java/com/rultor/web/TkSiblings.java

@@ -163,7 +163,6 @@ private Iterable<Directive> dirs(final Talk talk) throws IOException {
             dirs.append(TkSiblings.log(xml, log));
         }
         return dirs.up().add("name").set(talk.name()).up()
-            // @checkstyle MultipleStringLiteralsCheck (1 line)
             .add("href").set(xml.xpath("/talk/wire/href/text()").get(0)).up()
             .add("updated").set(Long.toString(talk.updated().getTime())).up()
             .add("timeago").set(new PrettyTime().format(talk.updated())).up()

src/test/java/com/rultor/TimeTest.java

@@ -30,7 +30,6 @@
 package com.rultor;
 
 import java.text.SimpleDateFormat;
-import java.util.Calendar;
 import java.util.Date;
 import java.util.Locale;
 import java.util.TimeZone;
@@ -54,7 +53,8 @@ final class TimeTest {
     void canParseValidTime() {
         final String date = "2005-10-08T15:48:39";
         Assertions.assertDoesNotThrow(
-            () -> new Time(date)
+            () -> new Time(date),
+            "Time should be able to create from date-time string"
         );
     }
 
@@ -71,7 +71,8 @@ void canParseValidTime() {
     void exceptionParseInvalidTime(final String date) {
         Assertions.assertThrows(
             IllegalStateException.class,
-            () -> new Time(date)
+            () -> new Time(date),
+            "Exception is expected for invalid date time string"
         );
     }
 
@@ -80,12 +81,13 @@ void exceptionParseInvalidTime(final String date) {
      */
     @Test
     void isoValidFormat() {
-        final Date date = Calendar.getInstance().getTime();
+        final Date date = new Date();
         final SimpleDateFormat format =
             new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'", Locale.US);
         format.setTimeZone(TimeZone.getTimeZone("GMT"));
         final Time time =  new Time(date);
         MatcherAssert.assertThat(
+            "ISO value should be for the GMT timezone",
             time.iso(),
             Matchers.equalTo(format.format(date))
         );
@@ -99,6 +101,7 @@ void defaultNowTime() {
         final Date date = new Date();
         final Time time = new Time();
         MatcherAssert.assertThat(
+            "Time without parameters should get current time",
             time.msec(),
             Matchers.allOf(
                 Matchers.greaterThanOrEqualTo(date.getTime()),
@@ -115,6 +118,7 @@ void fromDateValidTime() {
         final Date date = new Date();
         final Time time = new Time(date);
         MatcherAssert.assertThat(
+            "Time should get date from the parameter",
             time.msec(),
             Matchers.equalTo(date.getTime())
         );
@@ -128,6 +132,7 @@ void fromMsValidTime() {
         final Date date = new Date();
         final Time time = new Time(date.getTime());
         MatcherAssert.assertThat(
+            "Time should get msec value from parameter",
             time.msec(),
             Matchers.equalTo(date.getTime())
         );

src/test/java/com/rultor/agents/IndexesRequestsTest.java

@@ -64,6 +64,7 @@ void storesIndexIfNone() throws Exception {
         );
         new IndexesRequests().execute(talks);
         MatcherAssert.assertThat(
+            "Talk should be reindexed (1 based)",
             talks.get(name).read(),
             XhtmlMatchers.hasXPaths("/talk/request[@index='1']")
         );
@@ -94,14 +95,14 @@ void retrievesIndexFromLog() throws Exception {
         );
         new IndexesRequests().execute(talks);
         MatcherAssert.assertThat(
+            "Index value should be started from log records max",
             talks.get(name).read(),
             XhtmlMatchers.hasXPaths("/talk/request[@index='3']")
         );
     }
 
     /**
-     * IndexesRequests should retrieve index from sibling
-     * (the test is skipped, more information in #733).
+     * IndexesRequests should retrieve index from sibling.
      * @throws Exception In case of error.
      */
     @Test
@@ -141,6 +142,7 @@ void retrievesIndexFromSibling() throws Exception {
         );
         new IndexesRequests().execute(talks);
         MatcherAssert.assertThat(
+            "Index value should be started from log records max",
             talks.get(third).read(),
             XhtmlMatchers.hasXPaths("/talk/request[@index='5']")
         );
@@ -163,6 +165,7 @@ void notStoreIndexWithoutRequest() throws Exception {
         );
         new IndexesRequests().execute(talks);
         MatcherAssert.assertThat(
+            "Request tag should not be created if does not exist",
             talks.get(name).read(),
             Matchers.not(
                 XhtmlMatchers.hasXPaths("/talk/request")

src/test/java/com/rultor/agents/MailsTest.java

@@ -72,6 +72,7 @@ void sendsMail() throws Exception {
         Mockito.verify(postman).send(captor.capture());
         final Envelope envelope = captor.getValue();
         MatcherAssert.assertThat(
+            "Mail text should contain some data",
             envelope.unwrap().getContent().toString(),
             Matchers.allOf(
                 Matchers.containsString("See #456, release log:"),
@@ -83,6 +84,7 @@ void sendsMail() throws Exception {
             )
         );
         MatcherAssert.assertThat(
+            "Mail subject should be about release",
             envelope.unwrap().getSubject(),
             Matchers.equalTo("user/repo v2.0 released!")
         );

src/test/java/com/rultor/agents/PublishesTest.java

@@ -63,6 +63,7 @@ void addsPublicAttribute() throws Exception {
         );
         agent.execute(talk);
         MatcherAssert.assertThat(
+            "public attribute should be added",
             talk.read(),
             XhtmlMatchers.hasXPath("/talk[@public='true']")
         );
@@ -84,6 +85,7 @@ void ignoresIfPublicAttributeSet() throws Exception {
         );
         agent.execute(talk);
         MatcherAssert.assertThat(
+            "public attribute should be kept false",
             talk.read(),
             XhtmlMatchers.hasXPath("/talk[@public='false']")
         );

src/test/java/com/rultor/agents/daemons/ArchivesDaemonITCase.java

@@ -94,6 +94,7 @@ void archivesDaemon(@TempDir final Path temp) throws Exception {
             );
             agent.execute(talk);
             MatcherAssert.assertThat(
+                "archive tag should be created with bucket name",
                 talk.read(),
                 XhtmlMatchers.hasXPaths(
                     "/talk[not(daemon)]",

src/test/java/com/rultor/agents/daemons/DismountDaemonTest.java

@@ -71,6 +71,7 @@ void endsIfHostNotFound() throws IOException {
         final Agent agent = new DismountDaemon();
         agent.execute(talk);
         MatcherAssert.assertThat(
+            "Daemon should be stopped for not found host",
             talk.read(),
             XhtmlMatchers.hasXPaths(
                 "/talk/daemon/ended",
@@ -104,6 +105,7 @@ void ignoresFreshDaemons() throws IOException {
         final Agent agent = new DismountDaemon();
         agent.execute(talk);
         MatcherAssert.assertThat(
+            "Daemon should not be ended if younger then 10 days",
             talk.read(),
             XhtmlMatchers.hasXPaths("/talk/daemon[not(ended)]")
         );

src/test/java/com/rultor/agents/daemons/EndsDaemonITCase.java

@@ -40,6 +40,7 @@
 import com.rultor.spi.Talk;
 import java.io.IOException;
 import org.hamcrest.MatcherAssert;
+import org.hamcrest.Matchers;
 import org.hamcrest.core.StringContains;
 import org.hamcrest.core.StringEndsWith;
 import org.junit.jupiter.api.Assumptions;
@@ -78,6 +79,7 @@ void parsesHighlightedStdout() throws IOException {
             final Agent agent = new EndsDaemon();
             agent.execute(talk);
             MatcherAssert.assertThat(
+                "Rultor prefix should be moved to highlights",
                 talk.read(),
                 XhtmlMatchers.hasXPaths(
                     "/talk/daemon/highlights",
@@ -105,6 +107,7 @@ void readsExitCodeCorrectly() throws IOException {
             final Agent agent = new EndsDaemon();
             agent.execute(talk);
             MatcherAssert.assertThat(
+                "Status code should be placed to daemon/code",
                 talk.read(),
                 XhtmlMatchers.hasXPath("/talk/daemon[code='123']")
             );
@@ -133,6 +136,7 @@ void exitsWhenProfileBroken() throws Exception {
             final Agent agent = new EndsDaemon();
             agent.execute(talk);
             MatcherAssert.assertThat(
+                "Exception message should be placed in tail text",
                 talk.read(),
                 XhtmlMatchers.hasXPaths(
                     "/talk/daemon[code='154']",
@@ -165,15 +169,15 @@ void deprecatesDefaultImage() throws IOException {
                     final String dir = talk.read()
                         .xpath("/talk/daemon/dir/text()").get(0);
                     MatcherAssert.assertThat(
+                        "Deprecation message should be printed",
                         dir,
-                        StringContains.containsString(
-                            "#### Deprecation Notice ####"
+                        Matchers.allOf(
+                            StringContains.containsString(
+                                "#### Deprecation Notice ####"
+                            ),
+                            StringEndsWith.endsWith("##############")
                         )
                     );
-                    MatcherAssert.assertThat(
-                        dir,
-                        StringEndsWith.endsWith("##############")
-                    );
                 }
             }
         }
@@ -200,7 +204,6 @@ private PfShell start(final StartsDockerDaemon start, final Talk talk,
         talk.modify(
             new Directives().xpath("/talk")
                 .add("daemon")
-                // @checkstyle MultipleStringLiterals (1 line)
                 .attr("id", "abcd")
                 .add("title").set("merge").up()
                 .add("script").set("ls").up()

src/test/java/com/rultor/agents/daemons/KillsDaemonTest.java

@@ -62,6 +62,7 @@ void ignoresFreshDaemon() throws Exception {
         final Agent agent = new KillsDaemon();
         agent.execute(talk);
         MatcherAssert.assertThat(
+            "KillsDaemon stops daemon older then 1h by default",
             talk.read(),
             XhtmlMatchers.hasXPath("/talk/daemon")
         );

src/test/java/com/rultor/agents/daemons/StartsDaemonITCase.java

@@ -79,6 +79,7 @@ void startsDaemon() throws Exception {
         ) {
             final Talk talk = StartsDaemonITCase.talk(start);
             MatcherAssert.assertThat(
+                "started tag should be added with start time",
                 talk.read(),
                 XhtmlMatchers.hasXPaths(
                     "/talk/daemon[started and dir]",
@@ -95,6 +96,7 @@ void startsDaemon() throws Exception {
                 baos, baos
             );
             MatcherAssert.assertThat(
+                "Start script should be send to daemon",
                 baos.toString(StandardCharsets.UTF_8.name()),
                 Matchers.allOf(
                     Matchers.containsString("+ set -o pipefail"),
@@ -104,7 +106,9 @@ void startsDaemon() throws Exception {
                 )
             );
             MatcherAssert.assertThat(
-                new File(dir, "status").exists(), Matchers.is(false)
+                "status file should not be created",
+                new File(dir, "status").exists(),
+                Matchers.is(false)
             );
         }
     }
@@ -136,7 +140,11 @@ void deprecatesDefaultImage() throws IOException {
             } else {
                 matcher = Matchers.not(StringStartsWith.startsWith(notice));
             }
-            MatcherAssert.assertThat(dir, matcher);
+            MatcherAssert.assertThat(
+                "Deprecation message in case of default image should be printed",
+                dir,
+                matcher
+            );
         }
     }
 

src/test/java/com/rultor/agents/daemons/TailITCase.java

@@ -36,7 +36,7 @@
 import com.rultor.agents.shells.PfShell;
 import com.rultor.spi.Profile;
 import com.rultor.spi.Talk;
-import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
 import org.apache.commons.io.IOUtils;
 import org.hamcrest.MatcherAssert;
 import org.hamcrest.Matchers;
@@ -89,9 +89,10 @@ void tailsNonUtf() throws Exception {
                     .add("key").set(sshd.key()).up().up()
             );
             MatcherAssert.assertThat(
+                "SSH output should be in the Tail",
                 IOUtils.toString(
                     new Tail(talk.read(), hash).read(),
-                    Charset.forName("UTF-8")
+                    StandardCharsets.UTF_8
                 ),
                 Matchers.is(String.format("%sê\n", clean))
             );

src/test/java/com/rultor/agents/docker/StartsDockerDaemonTest.java

@@ -60,22 +60,24 @@ void providesPfShell() throws Exception {
         ) {
             final PfShell shell = start.shell();
             MatcherAssert.assertThat(
+                "Should login as root",
                 shell.login(),
                 Matchers.is("root")
             );
             final String key = shell.key();
             MatcherAssert.assertThat(
+                "Should be RSA key",
                 key,
-                Matchers.startsWith("-----BEGIN RSA PRIVATE KEY-----")
-            );
-            MatcherAssert.assertThat(
-                key,
-                Matchers.endsWith("-----END RSA PRIVATE KEY-----")
+                Matchers.allOf(
+                    Matchers.startsWith("-----BEGIN RSA PRIVATE KEY-----"),
+                    Matchers.endsWith("-----END RSA PRIVATE KEY-----")
+                )
             );
             final Shell.Plain ssh = new Shell.Plain(
                 new Ssh(shell.host(), shell.port(), shell.login(), shell.key())
             );
             MatcherAssert.assertThat(
+                "Key should be placed in /root/.ssh/id_rsa",
                 ssh.exec("cat /root/.ssh/id_rsa"),
                 Matchers.containsString(key)
             );