lazylead 0.1.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51f5479222983a306e063eb06e764100ea069e9a62854c478f9e0a14efdac5dd
-  data.tar.gz: 8e0052a4432740bd347c85c96267ecdc53f182e4a6716035839ad3ef5aec8d98
+  metadata.gz: 4564fa672731c29fe8e9dc32d2f09c56bf0b9245fce2900b4335c49442d08fb2
+  data.tar.gz: 58ff724cc12437d3106978913f0c2ef12a189f2e80b87ec07a2202bcd0f90267
 SHA512:
-  metadata.gz: 863fb878c397f0cb5b4861dae0db83ea02b9f795a4625af97c7b5426cd376e490270d98d90b1cda07fb960835fe90cb481ee6d315ecaa171221e4e3ac8ebb4e7
-  data.tar.gz: dd47bb278d2eef49b36820ffc9c181c87118b2d6e2a7099784ec8c17f97ed8165af1f3d01615ef8e4011c374d5054c4b74389e8b4625777db53798e63da48585
+  metadata.gz: e7b23097dca908102e6863d5527769bfe3d5405003cbab920da7ee6fd7f4118b554eb3d3a5f1170830dfdbf8fb08f752e6276fae4157f919f6e39ec070a91089
+  data.tar.gz: be8745b87907ab9ad30e9e4eb67f0ebf44ae0dcc01dcdbedefd79ab480e1222bbdc8835a397d465b5e491e995ee7ceaf685464385d7d87c0f0014900325d38ac

data/.circleci/config.yml

@@ -11,31 +11,43 @@ jobs:
       - run: |
           apk add libc-dev gcc make git sqlite sqlite-dev sqlite-libs
           bundler install
-      - run: rake test rubocop xcop
+      - run: bundle exec rake test rubocop sqlint xcop
   deploy:
     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/rll/commit/${CIRCLE_SHA1}"
-            docker build --build-arg release_tags="${CIRCLE_SHA1}, ${CIRCLE_BRANCH}, ${COMMIT_URL}" \
+            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
+            echo "Available LL images:"
+            docker images | grep lazylead
             docker run --rm dgroup/lazylead:${CIRCLE_BRANCH} bin/lazylead --verbose > trace.log
             cat trace.log
             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/.circleci/release_image.sh

@@ -1,13 +1,16 @@
 #!/bin/bash
-export docker_release_tags="latest 1 1.0.1 0.1.1"
-docker login --username $DOCKER_USER --password $DOCKER_TOKEN
+set -e
+echo "Release tags: ${DOCKER_RELEASE_TAGS}"
+docker login --username "${DOCKER_USER}" --password "${DOCKER_TOKEN}"
 if [ "${CIRCLE_BRANCH}" == "master" ]; then
-    for tag in ${docker_release_tags// / } ; do
-        docker tag dgroup/lazylead:$CIRCLE_BRANCH dgroup/lazylead:${tag}
-        docker push dgroup/lazylead:${tag}
+    for tag in ${DOCKER_RELEASE_TAGS// / } ; do
+        docker tag "dgroup/lazylead:${CIRCLE_BRANCH}" "dgroup/lazylead:${tag}"
+        docker push "dgroup/lazylead:${tag}"
         echo "dgroup/lazylead:${tag} released"
     done
 else
-    docker push dgroup/lazylead:$CIRCLE_BRANCH
+    docker push "dgroup/lazylead:${CIRCLE_BRANCH}"
     echo "dgroup/lazylead:${CIRCLE_BRANCH} released"
-fi
+fi
+echo "Available LL images:"
+docker images | grep lazylead

data/.docker/Dockerfile

@@ -1,31 +1,32 @@
 FROM ruby:2.6.5-alpine
 
 ARG release_tags
+ARG version
 
 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"
 
-ENV APP_HOME=/lazylead \
-    version=${release_tags}
+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
-ADD lib ./lib
-ADD upgrades ./upgrades
+COPY lib ./lib
+COPY upgrades ./upgrades
 
-CMD ["bin/lazylead", "--trace", "--verbose", "--memory-dump"]
+RUN sed -i "s/0\.0\.0/${version}/g" lib/lazylead/version.rb
 
-MAINTAINER 'Yurii Dubinka (yurii.dubinka@gmail.com)'
+CMD ["bin/lazylead", "--trace", "--verbose"]

data/.docker/docker-compose.yml

@@ -10,9 +10,9 @@ services:
     build:
       context: ../
       dockerfile: .docker/Dockerfile
-    environment:
-      # @todo #/DEV Add SHA2, version, release date, and url to commit.
-      release_tags: "0.1.0"
+      args:
+        release_tags: "latest 0.1.0"
+        version: "0.1.0"
     ports:
       - 82:8080
       - 1082:1082 # remote debug

data/.docker/readme.md

@@ -1,21 +1,24 @@
-#### Docker F.A.Q.
- - Prepare environment
-    ````bash
-    docker start <container_name>               # start particular container
-    docker start -i <container_name>            # start particular container in interactive mode
-    docker stop <container_name>                # stop particular container
-    docker ps                                   # display all running containers
-    docker ps -a                                # display all existing containers (stopped)
-    docker exec -it <container_name> /bin/bash  # join to the container via bash
-    docker rm <container_name>                  # remove particular container
-    docker rmi <image_name>                     # remove particular image
-    docker pull <image_name>                    # download particular image from the remote repository (NC Artifactory, dockerhub, etc)
-    ````
- - Monitoring
-    ```bash
-    # Display on-line information regarding system usage (CPU,RAM,IO) per container    
-    docker stats $(docker ps --format '{{.Names}}')        
-    docker stats $(docker ps | awk '{if(NR>1) print $NF}')
-    ```
- - [Cheat sheet](https://gist.github.com/dgroup/5046bac5531fae11242dd03201626f5b)
- - [Basics](https://github.com/wsargent/docker-cheat-sheet)
+#### Docker FAQ
+- Prepare environment
+  ````bash
+  docker start <container_name>               # start particular container
+  docker start -i <container_name>            # start particular container in interactive mode
+  docker stop <container_name>                # stop particular container
+  docker ps                                   # display all running containers
+  docker ps -a                                # display all existing containers (stopped)
+  docker exec -it <container_name> /bin/bash  # join to the container via bash
+  docker rm <container_name>                  # remove particular container
+  docker rmi <image_name>                     # remove particular image
+  docker pull <image_name>                    # download particular image from the remote repository (NC Artifactory, dockerhub, etc)  
+  ````
+
+- Monitoring
+  ```bash
+  # Display on-line information regarding system usage (CPU,RAM,IO) per container    
+  docker stats $(docker ps --format '{{.Names}}')        
+  docker stats $(docker ps | awk '{if(NR>1) print $NF}')
+  ```
+
+- [Cheat sheet](https://gist.github.com/dgroup/5046bac5531fae11242dd03201626f5b)
+
+- [Basics](https://github.com/wsargent/docker-cheat-sheet)

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/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", "fields":"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/.rubocop.yml

@@ -25,7 +25,7 @@ Metrics/BlockLength:
     - "*.gemspec"
     - "Rakefile"
     - "bin/lazylead"
-    - "test/lazylead/cli/start_test.rb"
+    - "test/**/*"
 
 Metrics/ClassLength:
   Exclude:

data/.rultor.yml

@@ -1,31 +1,30 @@
+architect:
+  - dgroup
 assets:
-  rubygems.yml: dgroup/ossrh#rubygems.yml
+  rubygems.yml: dgroup/home#rubygems.yml
+  circleci.header: dgroup/home#circleci.header
 install: |
   export GEM_HOME=~/.ruby
   export GEM_PATH=$GEM_HOME:$GEM_PATH
-  sudo apt-get -y update
-  sudo apt-get -y install libcurl4-openssl-dev
-  sudo gem install pdd -v 0.20.5
+docker:
+  image: ruby:2.6.5
 release:
   script: |-
+    set -e
     export RUBYOPT="-W0"
     [[ "${tag}" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]] || exit -1
     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
-    rake --quiet
-    git add lib/lazylead/version.rb
+    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
-architect:
-- dgroup
+    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: |-
     bundle install
-    rake --quiet
-    pdd -f /dev/null -v
-deploy:
-  script: |-
-    echo "There is nothing to deploy"
-    exit -1
+    bundle exec rake test rubocop sqlint xcop

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]
 )