Merge branch 'master' of github.com:tideflow-io/tideflow-agent

Author: joseconstela

.circleci/config.yml

@@ -0,0 +1,26 @@
+name: Node CI
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [8.x, 10.x, 11.x, 12.x, 13.x]
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: npm install, build, and test
+      run: |
+        npm ci
+        npm run build --if-present
+        npm test
+      env:
+        CI: true

.github/workflows/nodejs.yml

@@ -0,0 +1,30 @@
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12
+      - run: npm ci
+      - run: npm test
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

.github/workflows/npmpublish.yml

@@ -1 +1,2 @@
 node_modules
+a.js

.gitignore

@@ -1,17 +1,15 @@
-# Tideflow's agent [![CircleCI](https://circleci.com/gh/tideflow-io/tideflow-agent.svg?style=svg)](https://circleci.com/gh/tideflow-io/tideflow-agent) [![Greenkeeper badge](https://badges.greenkeeper.io/tideflow-io/tideflow-agent.svg)](https://greenkeeper.io/)
+# Tideflow's Self-hosted Runner 
 
-> Run commands as workflow steps via [Tideflow](https://tideflow.io)
+> With Tideflow's Self-hosted Runner, you can run workflow's task in your own server via [TideFlow](https://www.tideflow.io)
 
-## Install
+For more information, visit [TideFlow.io](https://www.tideflow.io)
 
-Ensure you have [Node.js](https://nodejs.org) version 8+ installed. Then run the following:
+## Usage
 
 ```bash
-npm i -g @tideflowio/tideflow-agent
+npx @tideflowio/tideflow-agent -t [token] -u tideflow.example.com
 ```
 
-## Usage
-
     $ tideflow-agent --help
     Usage: index [options]
 
@@ -27,21 +25,93 @@ npm i -g @tideflowio/tideflow-agent
       $ tideflow-agent --help
       $ tideflow-agent -h
 
-You can also run the agent without installing it, via npx.
-
-```bash
-npx @tideflowio/tideflow-agent -t [token] -u tideflow.example.com
-```
-
 ## Environment variables
 
 ```bash
 # Specify the URL to connect to the Tideflow's platform.
 # Optional. Defaults to localhost:1337 if no -u parameter set
 # Example: http://subdomain.example.com:1337
 TF_AGENT_URL
+
+# Specify authentication token.
+# Optional. Having the authentication token stored as an environment
+# variable allows users to run the agent without passing the -t parameter.
+# Example: d2a04f78-ff8a-4eb4-a12c-57fb7abf03a7
+TIDEFLOWIO_AGENT_TOKEN
 ```
 
-## Resources
+## How to process data from previous tasks
+
+Each of the predecesor tasks results is represented as an array element with
+two root properties:
+
+- **type**: an string that defines the kind of data retuned by the previous
+step (object, array, file, etc)
+- **data**: an object containing the task's result.
+
+### Command actions
+
+The result from previous tasks are sent to the agent commands via the parameter
+`--tf_previous`. 
+
+For example, if the command to run is `meow`, the agent will execute it as
+`meow --tf_previous <previous-tasks-output>`
+
+The previous task's output is an stringified representation of the following
+JSON array format:
+
+```json
+[ 
+  { 
+    "data": {
+      "firstName": "Jose",
+      "lastName": "Samantino",
+    },
+    "files": [
+      {
+        "fieldname": "file",
+        "url": "https://...?token=....",
+        "filename": "CV.pdf",
+        "mimetype": "application/pdf"
+      }
+    ],
+    "links": []
+  }
+]
+```
+
+### NodeJS SFC actions
+
+The result from previous tasks are stored in a file. You can get the absolute
+path to this file in a environment variable called `TF_PREVIOUS_FILE`. This is
+an example on how you can retrieve the previous actions results:
+
+```javascript
+// Include the FileSystem package to access file system files.
+const fs = require('fs')
+
+// Grab the full path of the file that contents previous actions results
+const filePath = process.env.TF_PREVIOUS_FILE
+
+// Read the file contents
+const fileContents = fs.readFileSync(filePath, 'utf8')
+
+// Conver the previous actions results to Javascript object
+const previousResults = JSON.parse(fileContents)
+```
+
+---
+
+## Contributing
+
+If you would like to contribute to Tideflow, check out the
+[Contributing Guide](https://docs.tideflow.io/docs/contribute).
+
+## License
+
+GNU AFFERO GENERAL PUBLIC LICENSE
+
+## Developer Resources
 
 - Documentation: https://docs.tideflow.io/docs/services-agent
+- Contribute: https://docs.tideflow.io/docs/contribute

.vscode/settings.json

@@ -10,7 +10,7 @@ const os = require('os')
  * @param {Object} cli's parameters parsed via commander's npm package
  */
 module.exports.exec = (program) => {
-
+  
   const cpusCounts = os.cpus().length
   const programConcurrency = program.concurrency || cpusCounts
   let concurrency = programConcurrency >= cpusCounts ? cpusCounts : programConcurrency
@@ -28,9 +28,9 @@ module.exports.exec = (program) => {
 
   // Shows welcome messages
   console.log(pretty.logo(pjson))
-  console.log(` || Tideflow.io - agent ${pjson.version}`.blue)
-  console.log(` || Using ${concurrency} as concurrency`.yellow)
-  console.log(` || Target URL ${URL}`.yellow)
+  console.log(` || ${new Date()} Tideflow.io - agent ${pjson.version}`.blue)
+  console.log(` || ${new Date()} Using ${concurrency} as concurrency`.yellow)
+  console.log(` || ${new Date()} Target URL ${URL}`.yellow)
 
   const socket = io(`${URL}?token=${program.token}`)
 
@@ -54,6 +54,16 @@ module.exports.exec = (program) => {
     q.push(services.githubCi.executionFinished(socket, 'tf.githubCi.push.execution.finished', req))
   })
 
+  socket.on('tf.githubCi.checksuite', (req) => {
+    if (!agent.authenticated) return
+    q.push(services.githubCi.checksuite(socket, 'tf.githubCi.checksuite', req))
+  })
+
+  socket.on('tf.githubCi.checksuite.execution.finished', (req) => {
+    if (!agent.authenticated) return
+    q.push(services.githubCi.executionFinished(socket, 'tf.githubCi.checksuite.execution.finished', req))
+  })
+
   socket.on('tf.githubCi.test_cmd', (req) => {
     if (!agent.authenticated) return
     q.push(services.githubCi.test_cmd(socket, 'tf.githubCi.test_cmd', req))
@@ -67,28 +77,30 @@ module.exports.exec = (program) => {
   // Execute command
   socket.on('tf.agent.execute', function (req) {
     if (!agent.authenticated) return
+    console.log(` => ${new Date()} ${req.execution} Execute`.blue)
     q.push(services.agent.execute(socket, 'tf.agent.execute', req))
   })
 
   socket.on('tf.agent.code_nodesfc', function(req) {
     if (!agent.authenticated) return
+    console.log(` => ${new Date()} ${req.execution} Node SFC`.blue)
     q.push(services.agent.codeNodeSfc(socket, 'tf.agent.code_nodesfc', req))
   })
 
   // Authorize agent
   socket.on('tf.authz', function (auth) {
     agent = Object.assign({authenticated: true}, agent, auth)
-    console.log(` || Agent ${auth.title} authorized`.green)
+    console.log(` || ${new Date()} Agent ${auth.title} authorized`.green)
   })
 
   // Show a connection lost message
   socket.on('reconnecting', function () {
-    console.error(` || Connection lost, reconnecting...`.red)
+    console.error(` || ${new Date()} Connection lost, reconnecting...`.red)
   })
 
   // Warm the user in case of error 
   socket.on('error', function (e) {
-    console.error(` || Error`.red)
-    console.error(` || ${e}`.red)
+    console.error(` || ${new Date()} Error`.red)
+    console.error(` || ${new Date()} ${e}`.red)
   })
-}
+}

LICENSE

@@ -1,7 +1,7 @@
 /**
  * Returns a pretty logo for terminal
  */
-module.exports.logo = (pjson) => {
+module.exports.logo = pjson => {
   return `                                       
   _   _   _     ___ _             _     
  | |_|_|_| |___|  _| |___ _ _ _  |_|___