lazylead 0.2.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc28e9d71a966a27880ceac0418cf722b6994e57e60301dc53808cb6bb57e3f2
-  data.tar.gz: 48724243edda1c24e01e75ea50a63a0775869493696f116485125a90097c7877
+  metadata.gz: 4834917c8eacf27d7514a99f4a8eb9f2c9dd7a19735c3ae9653105ecf8cd7463
+  data.tar.gz: f7d5c5f19e7be4c11de364a27099382b78d748ee091ed0c2c6de47d5b95b21bb
 SHA512:
-  metadata.gz: 1748fbb1289cefc4f893d4353544bc635f8942a9df33a0375f57ea14bafa135197ff328e9af4ae7d38fe7fcbc8a9cec6398c10aebd5a1a96a65f6047742ca0f7
-  data.tar.gz: 9646375b7bcfc1ae3e61ee6075c8eb26055953a423ab6b9c9ccd04311c672dcbcd4310cf9bd7b1a0b06bbdb57c8a186ac7352cdba894972204bb64cee3a7fdac
+  metadata.gz: 29bd5bdaed8330d9de652ab9d11126a1af79a84acc08b415db14f3a389592ac08e2c0ce1c35bd6733302aca808571a3f65d68183ceba20a7847cbb8e766eb921
+  data.tar.gz: b80e43c020c05b8b26d3745916934e737f2b7176515ff82fa40f901cd7a8e8a7eb81c2cc016bb845289f22b38eb65854e1c59080f58be6ae584f1f40f5a95e5e

data/.0pdd.yml

@@ -1,5 +1,8 @@
 errors:
   - yurii.dubinka@gmail.com
-
+alerts:
+  suppress:
+    - on-found-puzzle
+    - on-lost-puzzle
 tags:
   - pdd

data/.circleci/config.yml

@@ -16,12 +16,12 @@ jobs:
     machine: true
     steps:
       - checkout
-      # build the application image
       - run:
-          name: "Build docker image"
+          name: "Build LL image"
           command: |
             set -e
             COMMIT_URL="https://github.com/dgroup/lazylead/commit/${CIRCLE_SHA1}"
+            sed -i "s/0\.0\.0/${DOCKER_RELEASE_TAGS}/g" lib/lazylead/version.rb
             docker build --build-arg release_tags="${CIRCLE_SHA1}, ${CIRCLE_BRANCH}, ${COMMIT_URL}" --build-arg version="${DOCKER_RELEASE_TAGS:7}" \
               -t dgroup/lazylead:$CIRCLE_BRANCH . \
               -f .docker/Dockerfile
@@ -32,12 +32,22 @@ jobs:
             expected="No tasks found"
             echo "Ensure that app prints the line '${expected}'."
             grep --color "${expected}" trace.log
-      # publish the image
       - run:
-          name: "Deploy docker image"
+          name: "Push LL image"
           command: |
             chmod +x .circleci/release_image.sh
             .circleci/release_image.sh
+      - run:
+          name: "Build & push LL VCS image"
+          command: |
+            sed -i "s/0\.0\.0/${DOCKER_RELEASE_TAGS}/g" .docker/vcs.dockerfile
+            sed -i "s/0\.0\.0/${DOCKER_RELEASE_TAGS}/g" lib/lazylead/version.rb
+            docker build -t dgroup/lazylead:${DOCKER_RELEASE_TAGS}-vcs . -f .docker/vcs.dockerfile
+            docker push dgroup/lazylead:${DOCKER_RELEASE_TAGS}-vcs
+      - run:
+          name: "Reset tag to master"
+          command: |
+            curl -s -X POST -u ${CI_TOKEN}:""  --url "https://circleci.com/api/v2/project/gh/dgroup/lazylead/envvar" -H "accept: application/json" -H "content-type: application/json" -d "{ \"name\": \"DOCKER_RELEASE_TAGS\", \"value\": \"master\" }"
 workflows:
   version: 2
   build_and_test:

data/.docker/Dockerfile

@@ -12,15 +12,16 @@ ENV APP_HOME=/lazylead
 
 WORKDIR $APP_HOME
 
-# @todo #/DEV The current image size is about 150MB.
+# @todo #/DEV Original size of lazylead was 350 MB.
+#  After removing of unnecessary libraries it took 250 MB.
 #  The original alpine image is ~20MB.
 #  Image cleanup is required.
 RUN echo "Install 3rd-party libraries." \
-  && apk add libc-dev gcc make git sqlite sqlite-dev sqlite-libs tree less vim man bash unzip
+  && apk add --no-cache libc-dev gcc git make sqlite sqlite-dev sqlite-libs tree
 
 COPY Gemfile lazylead.gemspec ./
 
-RUN bundler install
+RUN bundler install --without development
 
 COPY bin/lazylead ./bin/lazylead
 COPY lib ./lib
@@ -28,4 +29,4 @@ COPY upgrades ./upgrades
 
 RUN sed -i "s/0\.0\.0/${version}/g" lib/lazylead/version.rb
 
-CMD ["bin/lazylead", "--trace", "--verbose", "--memory-dump"]
+CMD ["bin/lazylead", "--trace", "--verbose"]

data/.docker/vcs.dockerfile

@@ -0,0 +1,10 @@
+FROM dgroup/lazylead:0.0.0
+
+LABEL about="https://github.com/dgroup/lazylead" \
+      ci.contact="yurii.dubinka@gmail.com" \
+      ci.release.tag="${release_tags}" \
+      ll.docker.issues="https://github.com/dgroup/lazylead/issues?utf8=✓&q=label%3Adocker"
+
+RUN apk add --no-cache subversion git mercurial
+
+CMD ["bin/lazylead", "--trace", "--verbose"]

data/.docs/accuracy.md

@@ -0,0 +1,107 @@
+## Give the score for the format of each incoming ticket to your team
+#### Why?
+When you have a pipeline between several teams, there should be criteria on how to pass a task between groups.
+Without this, you may get the delays for your task because your team members have to do the work that is not their business, or they even don't have the skills to do it properly.
+As a result, it may cause task delays or quality decreasing.
+
+Even if you define the criteria for passing tasks between teams, it's tough to monitor that those criteria aren't violating. To hire a well-paid additional manager who will check each ticket and send emails its expensive unless you work for a bloody reach company.
+
+This rule periodically checks the format of the ticket, post score results to the ticket, and raise email (one email per bunch of tickets) to you with details.
+
+#### How to use lazylead for this
+Let's assume that 
+1.  Your team is working in Jira
+2.  You want daily to check the format of incoming defects to your team
+3.  [JQL](https://www.atlassian.com/blog/jira-software/jql-the-most-flexible-way-to-search-jira-14) for incoming defects: `project='PRJ' and type=Defect and created < -2h and created > -26h`.
+    This `< -2h` and `> -26h` gives reporter 2h to fill the ticket correctly, and, after that, the task will evaluate the ticket score.
+4.  you've saved this [JQL](https://www.atlassian.com/blog/jira-software/jql-the-most-flexible-way-to-search-jira-14) as jira filter with id `222`. 
+
+For simplicity, we are using [docker-compose](https://docs.docker.com/compose/):
+1.  Define yml file with `docker-compose` configuration in `lazylead.yml`
+    ```yml
+    version: '2.3'
+    services:
+      lazylead:
+        image: dgroup/lazylead:latest
+        container_name: lazylead
+        mem_limit: 128m
+        environment:
+          # The jira server details.
+          # Please ensure that your jira filter(s) grants this user to see issues.
+          # Sometimes jira filter(s) may be created with restricted visibility, thus
+          #  lazylead can't find the issues. 
+          jira_url: https://your.jira.com
+          jira_user: theuser
+          jira_password: thepass
+        volumes:
+          - ./:/lazylead/db
+        # db/ll.db is sqlite file with jira related annoying tasks
+        entrypoint: bin/lazylead --sqlite db/ll.db --trace --verbose
+    ```
+    
+2.  Create a container, using `docker-compose -f lazylead.yml up`
+    The container will stop as there were no tasks provided:
+    ```bash
+    ll > docker-compose -f lazylead.yml up                                                         
+    Creating lazylead ... done
+    Attaching to lazylead
+    lazylead    | [2020-08-09T06:17:32] DEBUG [main] Version: 0.4.0
+    lazylead    | [2020-08-09T06:17:32] DEBUG [main] Memory footprint at start is 52MB
+    lazylead    | [2020-08-09T06:17:32] DEBUG [main] Database: '/lazylead/db/ll.db', sql migration dir: '/lazylead/upgrades/sqlite'
+    lazylead    | [2020-08-09T06:17:32] DEBUG [main] Migration applied to /lazylead/db/ll.db from /lazylead/upgrades/sqlite
+    lazylead    | [2020-08-09T06:17:32] DEBUG [main] Database connection established
+    lazylead    | [2020-08-09T06:17:32] DEBUG [main] SMTP connection established with {host} as {user}.
+    lazylead    | [2020-08-09T06:17:32] WARN  [main] ll-001: No tasks found.
+    lazylead    | [2020-08-09T06:17:32] DEBUG [main] Memory footprint at the end is 67MB
+    ll > 
+    ```
+
+3.  Define your team and tasks in database. 
+    The tables structure defined [here](../upgrades/sqlite/001-install-main-lazylead-tables.sql).
+    Modify you [sqlite](https://sqlite.com/index.html) file(`ll.db`) using [DB Browser](https://sqlitebrowser.org/) or any similar tool.
+    ```sql
+    insert into teams (id, name, properties) 
+               values (1, 'Dream team with lazylead', '{}');
+    insert into systems(id, properties)    
+               values (1,'{"type":"Lazylead::Jira", "username":"${jira_user}", "password":"${jira_password}", "site":"${jira_url}", "context_path":""}');
+    insert into tasks (name, cron, enabled, id, system, team_id, action, properties)
+               values ('Post ticket score and accuracy to the tickets', 
+                       '0 8 * * 1-5', 
+                       'true',
+                       1, 1, 1, 
+                       'Lazylead::Task::Accuracy',
+                       '{
+                            "jql":    "filter=222", 
+                            "to":     "lead@fake.com",
+                            "rules":  "Lazylead::AffectedBuild",
+                            "colors": "{ "0": "#FF4F33", "35": "#FF9F33", "57": "#19DD1E", "90": "#0FA81A" }",
+                            "docs":         "https://github.com/dgroup/lazylead/blob/master/.github/ISSUE_TEMPLATE/bug_report.md",
+                            "max_results":  "200",
+                            "subject":      "[LL] Raised tickets",
+                            "template":     "lib/messages/accuracy.erb"
+                        }
+                       ');
+    ```
+    Yes, for task scheduling we are using [cron](https://crontab.guru).
+
+4.  Once you changed `./ll.db`, please restart the container using `docker-compose -f .github/tasks.yml restart`
+    ```bash
+    ll > docker-compose -f .github/tasks.yml restart
+    Restarting lazylead ... done
+    ```
+
+5.  Once task completed, please check your defects, they should have comment like
+    ![jira comment](accuracy_jira_comment.jpg)
+
+    and you'll get an email like
+    ![email](accuracy_email.jpg)
+    
+
+#### Where is the code?
+| Logic | Tests |
+| :-----: | :------: |
+| [accuracy.rb](../lib/lazylead/task/accuracy/accuracy.rb)| [accuracy_test.rb](../test/lazylead/task/accuracy/accuracy_test.rb) | 
+
+#### How can I add my own rules?
+The custom rules should extend `Lazylead::Requirement` class and placed it to the `lib/lazylead/task/accuracy` folder.
+After that, you need to mention your custom rules in `rules` option in the column `properties` from `tasks` table

data/.docs/duedate_expired.md

@@ -0,0 +1,92 @@
+## Notify Jira ticket assignee about expired(ing) due date 
+#### Why?
+Why do we need this if Jira has `Filter Subscription` feature:
+- https://confluence.atlassian.com/jira064/receiving-search-results-via-email-720416706.html
+- https://confluence.atlassian.com/jiracorecloud/advanced-searching-765593707.html
+
+As far as I know, filter subscription feature doesn't allow(for now) to group tickets by assignee and send to each of them personal message with missing due dates.
+Right now its just send whole list of tickets to you or specified group.
+In worst cases, shared responsibility leads to irresponsibility each individual.
+
+#### How to use lazylead for this
+Let's assume that 
+1.  JQL for tickets with expired due dates: `project = PRJ and resolution = unresolved and duedate < startOfDay()`
+2.  you've saved this JQL as jira filter with id `222`
+3.  you want to sent an email notification to each assignee about his/her missing due dates over `MS Exchange server` 
+
+For simplicity, we are using [docker-compose](https://docs.docker.com/compose/):
+1.  Define yml file with `docker-compose` configuration in `lazylead.yml`
+    ```yml
+    version: '2.3'
+    services:
+      lazylead:
+        image: dgroup/lazylead:latest
+        container_name: lazylead
+        mem_limit: 128m
+        environment:
+          # The jira server details.
+          # Please ensure that your jira filter(s) grants this user to see issues.
+          # Sometimes jira filter(s) may be created with restricted visibility, thus
+          #  lazylead can't find the issues. 
+          jira_url: https://your.jira.com
+          jira_user: theuser
+          jira_password: thepass
+          # The MS Exchange server details, please ensure that '/ews/Exchange.asm` 
+          #  will be after your server url. Just change the url to your server.
+          exchange_url: https://your.ms.exchange.server/ews/Exchange.asmx
+          exchange_user: theuser
+          exchange_password: the password
+        volumes:
+          - ./:/lazylead/db
+        # db/ll.db is sqlite file with jira related annoying tasks
+        entrypoint: bin/lazylead --sqlite db/ll.db --trace --verbose
+    ```
+    
+2.  Create a container, using `docker-compose -f lazylead.yml up`
+    The container will stop as there were no tasks provided:
+    ```bash
+    ll > docker-compose -f lazylead.yml up                                                         
+    Creating lazylead ... done
+    Attaching to lazylead
+    lazylead    | [2020-06-06T10:35:13] DEBUG Memory footprint at start is 52MB
+    lazylead    | [2020-06-06T10:35:13] DEBUG Database: '/lazylead/db/ll.db', sql migration dir: '/lazylead/upgrades/sqlite'
+    lazylead    | [2020-06-06T10:35:13] DEBUG Migration applied to /lazylead/db/ll.db from /lazylead/upgrades/sqlite
+    lazylead    | [2020-06-06T10:35:13] DEBUG Database connection established
+    lazylead    | [2020-06-06T10:35:13] WARN  SMTP connection enabled in test mode.
+    lazylead    | [2020-06-06T10:35:13] WARN  ll-001: No tasks found.
+    lazylead    | [2020-06-06T10:35:13] DEBUG Memory footprint at the end is 66MB
+    lazylead exited with code 0
+    ll > 
+    ```
+
+3.  Define your team and tasks in database. 
+    The tables structure defined [here](../upgrades/sqlite/001-install-main-lazylead-tables.sql).
+    Modify you [sqlite](https://sqlite.com/index.html) file(`ll.db`) using [DB Browser](https://sqlitebrowser.org/) or any similar tool.
+    You may add your email into tasks.properties `"cc":"your@email.com"` in order to be aware that developer got the message, but i don't recommend you as you'll get a dozen of messages in a few days :) .
+    ```sql
+    insert into teams (id, name, properties) 
+               values (1, 'Dream team with lazylead', '{}');
+    insert into systems(id, properties)    
+               values (1,'{"type":"Lazylead::Jira", "username":"${jira_user}", "password":"${jira_password}", "site":"${jira_url}", "context_path":""}');
+    insert into tasks (name, cron, enabled, id, system, team_id, action, properties)
+               values ('Expired due dates', 
+                       '0 8 * * 1-5', 
+                       'true',
+                       1, 1, 1, 
+                       'Lazylead::Task::AssigneeAlert',
+                       '{"sql":"filter=222", "cc":"<youremail.com>", "subject":"[LL] Expired due dates", "template":"lib/messages/due_date_expired.erb", "postman":"Lazylead::Exchange"}');
+    
+    ```
+    Yes, for task scheduling we are using [cron](https://crontab.guru).
+
+4.  Once you changed `./ll.db`, please restart the container using `docker-compose -f .github/tasks.yml restart`
+    ```bash
+    ll > docker-compose -f .github/tasks.yml restart
+    Restarting lazylead ... done
+    ```
+
+
+#### Where is the code?
+| Logic | Tests | Email Template |
+| :-----: | :------: | :-----: |
+| AssigneeAlert in [alert.rb](../lib/lazylead/task/alert.rb)| [duedate_test.rb](../test/lazylead/task/duedate_test.rb) | [due_date_expired.erb](../lib/messages/due_date_expired.erb) |

data/.docs/propagate_down.md

@@ -0,0 +1,89 @@
+## Propagate fields from parent Jira ticket to sub-tasks
+#### Why?
+Why do we need this if Jira has automation already?
+
+Could you able use this feature right now? Just right now, without requests to some admin/jira owner/submitting some tickets to someone/etc... I doubt.
+In a huge company that's almost impossible to change something special for you in short terms. 
+
+#### How to use lazylead for this
+Let's assume that 
+1.  JQL for parent tickets for the propagation: `issue in parentsOf("project='PRJ' and 'External ID' is empty") and "External ID" is not empty and updated >-1d`.
+2.  you've saved this JQL as jira filter with id `222`. 
+
+For simplicity, we are using [docker-compose](https://docs.docker.com/compose/):
+1.  Define yml file with `docker-compose` configuration in `lazylead.yml`
+    ```yml
+    version: '2.3'
+    services:
+      lazylead:
+        image: dgroup/lazylead:latest
+        container_name: lazylead
+        mem_limit: 128m
+        environment:
+          # The jira server details.
+          # Please ensure that your jira filter(s) grants this user to see issues.
+          # Sometimes jira filter(s) may be created with restricted visibility, thus
+          #  lazylead can't find the issues. 
+          jira_url: https://your.jira.com
+          jira_user: theuser
+          jira_password: thepass
+        volumes:
+          - ./:/lazylead/db
+        # db/ll.db is sqlite file with jira related annoying tasks
+        entrypoint: bin/lazylead --sqlite db/ll.db --trace --verbose
+    ```
+    
+2.  Create a container, using `docker-compose -f lazylead.yml up`
+    The container will stop as there were no tasks provided:
+    ```bash
+    ll > docker-compose -f lazylead.yml up                                                         
+    Creating lazylead ... done
+    Attaching to lazylead
+    lazylead    | [2020-06-06T10:35:13] DEBUG Memory footprint at start is 52MB
+    lazylead    | [2020-06-06T10:35:13] DEBUG Database: '/lazylead/db/ll.db', sql migration dir: '/lazylead/upgrades/sqlite'
+    lazylead    | [2020-06-06T10:35:13] DEBUG Migration applied to /lazylead/db/ll.db from /lazylead/upgrades/sqlite
+    lazylead    | [2020-06-06T10:35:13] DEBUG Database connection established
+    lazylead    | [2020-06-06T10:35:13] WARN  SMTP connection enabled in test mode.
+    lazylead    | [2020-06-06T10:35:13] WARN  ll-001: No tasks found.
+    lazylead    | [2020-06-06T10:35:13] DEBUG Memory footprint at the end is 66MB
+    lazylead exited with code 0
+    ll > 
+    ```
+
+3.  Define your team and tasks in database. 
+    The tables structure defined [here](../upgrades/sqlite/001-install-main-lazylead-tables.sql).
+    Modify you [sqlite](https://sqlite.com/index.html) file(`ll.db`) using [DB Browser](https://sqlitebrowser.org/) or any similar tool.
+    ```sql
+    insert into teams (id, name, properties) 
+               values (1, 'Dream team with lazylead', '{}');
+    insert into systems(id, properties)    
+               values (1,'{"type":"Lazylead::Jira", "username":"${jira_user}", "password":"${jira_password}", "site":"${jira_url}", "context_path":""}');
+    insert into tasks (name, cron, enabled, id, system, team_id, action, properties)
+               values ('Propagate customfield_1 (External ID) to sub-tasks', 
+                       '0 8 * * 1-5', 
+                       'true',
+                       1, 1, 1, 
+                       'Lazylead::Task::PropagateDown',
+                       '{"jql":"filter=222", "propagate":"customfield_1"}');
+    
+    ```
+    Yes, for task scheduling we are using [cron](https://crontab.guru).
+
+4.  Once you changed `./ll.db`, please restart the container using `docker-compose -f .github/tasks.yml restart`
+    ```bash
+    ll > docker-compose -f .github/tasks.yml restart
+    Restarting lazylead ... done
+    ```
+
+5.  Once task completed, please check your sub-tasks, they should have `customfield_1` and comment like
+    ```text
+    The following fields were propagated from <parent-ticket-key>:
+    ||Field||Value||
+    |customfield_1|<parent-field-value>|
+    Posted by [lazylead v0.0.0|https://bit.ly/2NjdndS]]
+    ```
+
+#### Where is the code?
+| Logic | Tests |
+| :-----: | :------: |
+| [propagate_down.rb](../lib/lazylead/task/propagate_down.rb)| [propagate_down_test.rb](../test/lazylead/task/propagate_down_test.rb) | 

data/.pdd

@@ -2,4 +2,4 @@
 --verbose
 --exclude target/**/*
 --exclude coverage/**/*
---rule min-words:5
+--rule min-words:7

data/.rubocop.yml

@@ -25,7 +25,7 @@ Metrics/BlockLength:
     - "*.gemspec"
     - "Rakefile"
     - "bin/lazylead"
-    - "test/lazylead/cli/start_test.rb"
+    - "test/**/*"
 
 Metrics/ClassLength:
   Exclude:
@@ -77,6 +77,12 @@ Style/HashTransformKeys:
 Style/HashTransformValues:
   Enabled: true
 
+# @todo #/DEV accuracy.rb is using % symbol in text message and rubocop
+#  complains about it. It's false-positive violation, thus, for now ignored for this file
+Style/FormatStringToken:
+  Exclude:
+    - "lib/lazylead/task/accuracy/accuracy.rb"
+
 Lint/RaiseException:
   Enabled: true
 

data/.rultor.yml

@@ -16,13 +16,13 @@ release:
     sed -i "s/0\.0\.0/${tag}/g" lib/lazylead/version.rb
     sed -i "s/0\.0\.0/${tag}/g" lazylead.gemspec
     bundle install --no-color
-    bundle exec rake test rubocop sqlint xcop
+    bundle exec rake --trace test rubocop sqlint xcop
     git add lib/lazylead/version.rb lazylead.gemspec
     git commit -m "version set to ${tag}"
     gem build lazylead.gemspec
     chmod 0600 ../rubygems.yml
     gem push *.gem --config-file ../rubygems.yml
-    curl -s -X POST --url "https://circleci.com/api/v2/project/gh/dgroup/lazylead/envvar" -H @../circleci.header -H "accept: application/json" -H "content-type: application/json" -d "{ \"name\": \"DOCKER_RELEASE_TAGS\", \"value\": \"latest ${tag}\" }" -o /dev/null
+    curl -s -X POST --url "https://circleci.com/api/v2/project/gh/dgroup/lazylead/envvar" -H @../circleci.header -H "accept: application/json" -H "content-type: application/json" -d "{ \"name\": \"DOCKER_RELEASE_TAGS\", \"value\": \"${tag}\" }" -o /dev/null
     curl -s -X POST --url https://circleci.com/api/v2/project/gh/dgroup/lazylead/pipeline -H @../circleci.header -H 'accept: application/json' -H 'content-type: application/json' -H 'x-attribution-login: dgroup' -o /dev/null
 merge:
   script: |-

data/.simplecov

@@ -1,11 +1,5 @@
 # encoding: utf-8
 
-# @todo #/DEV Increase code coverage from 75% to 80%+.
-#  Right now it was decreased to 75% due to long manual setup of
-#  dev. instances of Atlassian Jira and Confluence.
-#  It was configured locally and there is no automation for now how
-#  it can be included quickly into CI process. This need to be done later.
-
 SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
   [SimpleCov::Formatter::HTMLFormatter]
 )