You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ignite.apache.org by dp...@apache.org on 2019/06/09 21:57:46 UTC

[ignite-teamcity-bot] branch master updated: TC Bot engine module description

This is an automated email from the ASF dual-hosted git repository.

dpavlov pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ignite-teamcity-bot.git


The following commit(s) were added to refs/heads/master by this push:
     new 020e692  TC Bot engine module description
020e692 is described below

commit 020e692183587e9ae2fe2973c6e7822e734bb649
Author: Dmitriy Pavlov <dp...@apache.org>
AuthorDate: Mon Jun 10 00:57:41 2019 +0300

    TC Bot engine module description
---
 README.md                                                     | 11 +++++++++--
 settings.gradle                                               |  2 +-
 tcbot-engine/README.md                                        |  3 +++
 .../org/apache/ignite/tcbot/engine/ui/DsHistoryStatUi.java    |  2 +-
 .../java/org/apache/ignite/tcbot/engine/ui/DsProblemRef.java  |  2 +-
 .../org/apache/ignite/tcbot/engine/ui/DsTestFailureUi.java    |  2 +-
 {tcbot-server => tcbot-server-node}/README.md                 |  0
 {tcbot-server => tcbot-server-node}/build.gradle              |  0
 .../java/org/apache/ignite/ci/TcBotIgniteServerLauncher.java  |  0
 9 files changed, 16 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 7eadef2..2389296 100644
--- a/README.md
+++ b/README.md
@@ -60,6 +60,13 @@ TeamCity Bot Components and its interactions
 
 <img src="https://docs.google.com/drawings/d/e/2PACX-1vQM6tH6-pb6C_JGjNG41sUBJP72CVpNqeBHIQdgaGYL4rGoYfZtywwzVB1JKF1Kk8haXUVl_IORI6NQ/pub?w=1356&h=733">
 
+### Modules structure
 Static content is placed in [webapp](ignite-tc-helper-web/src/main/webapp).
-TC Bot services can be found in [tcbot](ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/tcbot). 
-TC Bot integrations are placed in corresponding subpackages in [ci](ignite-tc-helper-web/src/main/java/org/apache/ignite/ci).
\ No newline at end of file
+
+TC Bot services can be found in [tcbot-engine](tcbot-engine)
+
+TC Bot integrations are placed in corresponding submodules
+| Data Source | Pure Integration | Persistence-enabled |
+| ----------- | ---------------- | ------------------ |
+| Teamcity | [tcbot-teamcity](tcbot-teamcity) | [tcbot-teamcity-ignited](tcbot-teamcity-ignited)  |
+
diff --git a/settings.gradle b/settings.gradle
index 240b0c5..b421c7c 100644
--- a/settings.gradle
+++ b/settings.gradle
@@ -1,6 +1,6 @@
 include 'ignite-tc-helper-web'
 include 'jetty-launcher'
-include 'tcbot-server'
+include 'tcbot-server-node'
 include 'tcbot-common'
 include 'tcbot-persistence'
 include 'tcbot-teamcity'
diff --git a/tcbot-engine/README.md b/tcbot-engine/README.md
new file mode 100644
index 0000000..8d612fe
--- /dev/null
+++ b/tcbot-engine/README.md
@@ -0,0 +1,3 @@
+TC Bot engine is main module with TC Bot logic independent from Web engine.
+
+TC Bot engine declares beans, that can serve to export some UI models.
\ No newline at end of file
diff --git a/tcbot-engine/src/main/java/org/apache/ignite/tcbot/engine/ui/DsHistoryStatUi.java b/tcbot-engine/src/main/java/org/apache/ignite/tcbot/engine/ui/DsHistoryStatUi.java
index 844f207..a718e47 100644
--- a/tcbot-engine/src/main/java/org/apache/ignite/tcbot/engine/ui/DsHistoryStatUi.java
+++ b/tcbot-engine/src/main/java/org/apache/ignite/tcbot/engine/ui/DsHistoryStatUi.java
@@ -21,7 +21,7 @@ import java.util.Objects;
 import javax.annotation.Nullable;
 
 /**
- * Test failure summary: contains statistic of failures and total runs for suite or for test.
+ * Detailed status of failures: Test/suite failure summary: contains statistic of failures and total runs for suite or for test.
  */
 public class DsHistoryStatUi {
     /** Registered number of failures from TC helper DB */
diff --git a/tcbot-engine/src/main/java/org/apache/ignite/tcbot/engine/ui/DsProblemRef.java b/tcbot-engine/src/main/java/org/apache/ignite/tcbot/engine/ui/DsProblemRef.java
index f20dd72..23fe3bd 100644
--- a/tcbot-engine/src/main/java/org/apache/ignite/tcbot/engine/ui/DsProblemRef.java
+++ b/tcbot-engine/src/main/java/org/apache/ignite/tcbot/engine/ui/DsProblemRef.java
@@ -18,7 +18,7 @@
 package org.apache.ignite.tcbot.engine.ui;
 
 /**
- * Reference to some Issue with current suite or test detected by the Bot.
+ * Detailed status of failures: Reference to some Issue with current suite or test detected by the Bot.
  * Currently contains only display name.
  */
 public class DsProblemRef {
diff --git a/tcbot-engine/src/main/java/org/apache/ignite/tcbot/engine/ui/DsTestFailureUi.java b/tcbot-engine/src/main/java/org/apache/ignite/tcbot/engine/ui/DsTestFailureUi.java
index 6c86abb..b0cb5d9 100644
--- a/tcbot-engine/src/main/java/org/apache/ignite/tcbot/engine/ui/DsTestFailureUi.java
+++ b/tcbot-engine/src/main/java/org/apache/ignite/tcbot/engine/ui/DsTestFailureUi.java
@@ -39,7 +39,7 @@ import static org.apache.ignite.tcbot.common.util.TimeUtil.millisToDurationPrint
 
 
 /**
- * UI model for test failure, probably merged with its history
+ * Detailed status of failures: UI model for test failure, probably merged with its history
  */
 @SuppressWarnings({"WeakerAccess", "PublicField"})
 public class DsTestFailureUi {
diff --git a/tcbot-server/README.md b/tcbot-server-node/README.md
similarity index 100%
rename from tcbot-server/README.md
rename to tcbot-server-node/README.md
diff --git a/tcbot-server/build.gradle b/tcbot-server-node/build.gradle
similarity index 100%
rename from tcbot-server/build.gradle
rename to tcbot-server-node/build.gradle
diff --git a/tcbot-server/src/main/java/org/apache/ignite/ci/TcBotIgniteServerLauncher.java b/tcbot-server-node/src/main/java/org/apache/ignite/ci/TcBotIgniteServerLauncher.java
similarity index 100%
rename from tcbot-server/src/main/java/org/apache/ignite/ci/TcBotIgniteServerLauncher.java
rename to tcbot-server-node/src/main/java/org/apache/ignite/ci/TcBotIgniteServerLauncher.java