Cloud Walk Technical Test

Table of Contents

Cloud Walk Technical Test
Test specification

Requirements

Tools and Methodologies used

Bonzai (for generating the binary-tree)
Unit Test

How to produce the binaries (Install)

Local build

git clone https://github.com/BuddhiLW/cloud-walk-techtest.git
bash ./build.sh

Now you should have the new binary file in the project root called qrep (qrep stands for quake report).

Fetch with Go command-line

go install github.com/BuddhiLW/cloud-walk-techtest/cmd/[email protected] // stable release
// latest: go install github.com/BuddhiLW/cloud-walk-techtest/cmd/qrep@latest

For autocompletion magic, insert this line (any place), in your ~/.bashrc and restart the shell:

complete -C qrep qrep

You will be able to type qrep <TAB> and get completions.

qrep.mp4

How to use the binaries

Make sure the permissions are given to read, write and execute,

chmod +rwx ./qrep

Then, use qrep as follows,

To get an explanation of any command (`man` page format)

Man page help

./qrep help

NAME
       qrep - Quake Report: A Bonzai composite command tree, for generating Reports for Cloud Walk technical test

SYNOPSIS
       qrep COMMAND

COMMANDS
       help           - display help similar to man page format
       conf           - manage conf in /home/galois/.config/qrep/config.yaml
       var            - cache variables in /home/galois/.cache/qrep/vars
       data|json|qrep - *qrep* is a quake-report binary.

DESCRIPTION
       Quake Report is a Bonzai composite command tree, for generating Reports for Cloud Walk technical test.

       It is a simple CLI application that generates a report for the given earthquake data.

       You can use the following commands to generate the report:

       * qrep command help      (documentation for the command)
       * qrep data
       * qrep data n            (where n is the match you want json-formatted data about)
       * qrep data rank n       (where n is the given match-ranking)
       * qrep data stats n      (where n is the given match-stats -- kills by type)

       See the README.md for more information and examples, or use *_command-tree_ help* to see another man-page about the specific command-tree.

CONTACT
       Site:   buddhilw.com
       Source: [email protected]:BuddhiLW/cloud-walk-techtest.git
       Issues: github.com/BuddhiLW/cloud-walk-techtest/issues

LEGAL
       qrep (v1.0.1) Copyright 2024 Pedro G. Branquinho
       License Apache-2.0

Another example

To illustrate the case of qrep data help for getting to know more about the command

./qrep data help

NAME
       report - data, or report, is the root of the quake-report binary-tree.

ALIASES
       report (data)

SYNOPSIS
       report <number>

COMMANDS
       help                     - display help similar to man page format
       r|rank                   - display **ranking** for a given **match**
       stats|bydeath|statistics - display statistics of a **match** by **death type**

To get all matches data (Implementation)

Call qrep data without arguments:

./qrep data

The expected output looks like this:

All games (N):  22
---------------------------------

{
   "game_1": {
       "total_kills": 0,
       "players": [
           "Isgalamido"
       ],
       "kills": {
           "Isgalamido": 0
       }
   },
   "game_10": {
       "total_kills": 60,
       "players": [
           "Mal",
           "Assasinu Credi",
           "Isgalamido",
           "Oootsimo",
           "Dono da Bola",
           "Zeh",
           "Chessus"
       ],
       "kills": {
(...)

Notes:

The output is not ordered like "game_1", "game_2", etc., but contains all games.
The message "All games (N): 22\n ------------" is only in log (debug channel);
Therefore, the output can be "isolated" to only the json data by pipping the result to a file. E.g., ./qrep data > tmp.txt

Report only the match data (Implementation)

Call qrep data n, with n as the argument:

./qrep data <n>

The expected output looks like this:

./qrep data 10

2024/03/13 19:35:04 JSON data for Match:
2024/03/13 19:35:04 Match chosen: 10
{
    "total_kills": 60,
    "players": [
        "Chessus",
        "Mal",
        "Assasinu Credi",
        "Isgalamido",
        "Oootsimo",
        "Dono da Bola",
        "Zeh"
    ],
    "kills": {
        "Assasinu Credi": 3,
        "Chessus": 5,
        "Dono da Bola": 3,
        "Isgalamido": 6,
        "Mal": 1,
        "Oootsimo": -1,
        "Zeh": 7
    }
}

Report by death-type, the match (Implementation)

To get json-formatted statistics, by grouping kills by kill-type in a given match, we can use qrep data stats, qrep data statistics or qrep data bydeath.

E.g.,

./qrep data stats 4

2024/03/13 21:36:53 Stats of match << 4 >> (by death type)
{
    "MOD_FALLING": 11,
    "MOD_MACHINEGUN": 4,
    "MOD_RAILGUN": 8,
    "MOD_ROCKET": 20,
    "MOD_ROCKET_SPLASH": 51,
    "MOD_SHOTGUN": 2,
    "MOD_TRIGGER_HURT": 9
}

Report players ranking for the match (Implementation)

The compose-command rank defaults to a pretty print

./qrep data rank 10

2024/03/13 21:05:16 Rank of match number << 10 >>
2024/03/13 21:05:16 --------- (by kills) -----------
2024/03/13 21:05:16 In text:

Name: Zeh,            Kills: 7,  Position: 1
Name: Isgalamido,     Kills: 6,  Position: 2
Name: Chessus,        Kills: 5,  Position: 3
Name: Assasinu Credi, Kills: 3,  Position: 4
Name: Dono da Bola,   Kills: 3,  Position: 5
Name: Mal,            Kills: 1,  Position: 6
Name: Oootsimo,       Kills: -1, Position: 7

But, you can also specify a json output format, like so (unordered):

./qrep data rank json 10

2024/03/13 21:07:48 In json:

{
    "Assasinu Credi": {
        "name": "Assasinu Credi",
        "kills": 3,
        "position": 4
    },
    "Chessus": {
        "name": "Chessus",
        "kills": 5,
        "position": 3
    },
    "Dono da Bola": {
        "name": "Dono da Bola",
        "kills": 3,
        "position": 5
    },
    "Isgalamido": {
        "name": "Isgalamido",
        "kills": 6,
        "position": 2
    },
    "Mal": {
        "name": "Mal",
        "kills": 1,
        "position": 6
    },
    "Oootsimo": {
        "name": "Oootsimo",
        "kills": -1,
        "position": 7
    },
    "Zeh": {
        "name": "Zeh",
        "kills": 7,
        "position": 1
    }
}

Test specification

The test consists in parsing a log file and outputting a json as a respose.

Relevant data

Log to be parsed: https://gist.github.com/cloudwalk-tests/be1b636e58abff14088c8b5309f575d8

Log in raw format: https://gist.githubusercontent.com/cloudwalk-tests/be1b636e58abff14088c8b5309f575d8/raw/df6ef4a9c0b326ce3760233ef24ae8bfa8e33940/qgames.log

Goal (Parse)

Transform log into this structure, per game-match

"game_1": {
"total_kills": 45,
"players": ["Dono da bola", "Isgalamido", "Zeh"],
"kills": {
  "Dono da bola": 5,
  "Isgalamido": 18,
  "Zeh": 20
  }
}

Print it on console

Goal (Script Report and Ranking)

Create a script that prints a report (grouped information) for each match and a player ranking.

Goal (Report by Death type)

Generate a report of deaths grouped by death cause for each match.

buddhilw / cloud-walk-techtest Goto Github PK

cloud-walk-techtest's Introduction