Add development environment (#20)

* Add development environment

* Add pull request template

Author: miguelbemartin

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,3 @@
+<!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. -->
+
+Fixes # (issue)

.github/workflows/test.yml

@@ -0,0 +1,19 @@
+name: teamwork
+
+on:
+  pull_request:
+    types: [opened, closed]
+  pull_request_review:
+    types: [submitted, dismissed]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ensure this project runs
+    steps:
+      - uses: actions/checkout@v1
+      - uses: ./
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          TEAMWORK_URI: "localhost"
+          TEAMWORK_API_TOKEN: "test_api_token"

CONTRIBUTING.md

@@ -12,17 +12,17 @@
 Simulate a new pull request
 
 ```
-act pull_request -e events/pull_request_opened.json
+act pull_request -e tests/events/pull_request_opened.json
 ```
 
 Simulate a pull request has been approved
 
 ```
-act pull_request -e events/pull_request_approved.json
+act pull_request_review -e tests/events/pull_request_approved.json
 ```
 
 Simulate a pull request has been merged
 
 ```
-act pull_request -e events/pull_request_merged.json
+act pull_request -e tests/events/pull_request_merged.json
 ```

src/main.sh

@@ -18,6 +18,8 @@ main() {
   export TEAMWORK_URI="$2"
   export TEAMWORK_API_TOKEN="$3"
 
+  env::set_environment
+
   # Check if there is a task link in the PR
   local -r pr_body=$(github::get_pr_body)
   local -r task_id=$(teamwork::get_task_id_from_body "$pr_body" )

src/misc.sh

@@ -8,3 +8,11 @@ log::message() {
   echo "--------------"
   echo "$@"
 }
+
+env::set_environment() {
+  if [ "$TEAMWORK_URI" == "localhost" ] && [ "$TEAMWORK_API_TOKEN" == "test_api_token" ]; then
+    export ENV="test"
+  else
+    export ENV="prod"
+  fi
+}

src/teamwork.sh

@@ -13,12 +13,17 @@ teamwork::get_task_id_from_body() {
 teamwork::add_comment() {
   local -r body=$1
 
+  if [ "$ENV" == "test" ]; then
+    log::message "Test - Simulate request. Task ID: $TEAMWORK_TASK_ID - Comment: ${body//\"/}"
+    return
+  fi
+
   response=$(curl -X "POST" "$TEAMWORK_URI/projects/api/v1/tasks/$TEAMWORK_TASK_ID/comments.json" \
        -u "$TEAMWORK_API_TOKEN"':' \
        -H 'Content-Type: application/json; charset=utf-8' \
        -d "{ \"comment\": { \"body\": \"${body//\"/}\", \"notify\": \"\", \"content-type\": \"text\", \"isprivate\": false } }" )
 
-  echo "$response"
+  log::message "$response"
 }
 
 teamwork::pull_request_opened() {

tests/events/pull_request_approved.json

@@ -0,0 +1,21 @@
+{
+  "action": "submitted",
+  "number": 1,
+  "pull_request": {
+    "body": "This is the body of the PR. https://xxxx.teamwork.com/#/tasks/123 https://xxx.teamwork.com/#/tasks/456",
+    "head": {
+      "repo": {
+        "full_name": "teamwork/github-sync"
+      }
+    },
+    "html_url": "https://github.com/teamwork/github-sync/pull/2",
+    "title": "This is an example of a title for the PR."
+  },
+  "review": {
+    "state": "approved",
+    "body": "This is the comment of the review."
+  },
+  "sender": {
+    "login": "username"
+  }
+}

tests/events/pull_request_merged.json

@@ -0,0 +1,18 @@
+{
+  "action": "closed",
+  "number": 1,
+  "merged": true,
+  "pull_request": {
+    "body": "This is the body of the PR. https://xxxx.teamwork.com/#/tasks/123 https://xxx.teamwork.com/#/tasks/456",
+    "head": {
+      "repo": {
+        "full_name": "teamwork/github-sync"
+      }
+    },
+    "html_url": "https://github.com/teamwork/github-sync/pull/1",
+    "title": "This is an example of a title for the PR."
+  },
+  "sender": {
+    "login": "username"
+  }
+}

tests/events/pull_request_opened.json

@@ -0,0 +1,17 @@
+{
+  "action": "opened",
+  "number": 1,
+  "pull_request": {
+    "body": "This is the body of the PR. https://xxxx.teamwork.com/#/tasks/123 https://xxx.teamwork.com/#/tasks/456",
+    "head": {
+      "repo": {
+        "full_name": "teamwork/github-sync"
+      }
+    },
+    "html_url": "https://github.com/teamwork/github-sync/pull/1",
+    "title": "This is an example of a title for the PR."
+  },
+  "sender": {
+    "login": "username"
+  }
+}