Home

Microspector

Micro Service Inspector A scripting language designed to test microservices and RESTful APIs in a sexy way.

Detailed wiki is coming soon

Usage of ./microspector:
  -file string
        task file path
  -folder string
        tasks folder path
  -verbose
        print out logs
  -version
        prints version

Scripting

Writing a script in microspector is as simple as

SET  Url  "https://microspector.com/test.json"
HTTP GET  Url   HEADER "User-Agent:My super duper API test tool" INTO  ApiResult 
MUST  ApiResult.Json.boolean  == true
HTTP POST "https://hooks.slack.com/services/SLACK_TOKEN" 
     HEADER "User-Agent:Microspector
     Content-type: application/json"
     BODY '{ "text":"Oh!:( Microspector API returns false in json.boolean, you broke it!" }'
     INTO  SlackResult  
     WHEN  ApiResult.Json.boolean  != true

Variables

Variables can be used like VariableName, {{ VariableName }} OR $VariableName all supported in order to combine with any other templating and some brackets to allow reserved keywords being used as variable name. For example set $set 1 and set {{ set }} 1 will set a variable named set while set set 1 failing because set is a command Variables can be accessed and set in same way. Accessing supports nested variables like HttpResult.Json.message but setting does not yet.

Commands

A Microspector script is a basic set of commands. Every command takes some params does the rest accordingly.

Currently supported commands are:

1. SET
2. HTTP
3. ASSERT
4. MUST
5. SHOULD
6. DEBUG
7. END
8. INCLUDE
9. SLEEP

SET

Set command is used to define and set a variable

Example:

SET $Url "https://microspector.com"
SET  Url  "https://microspector.com"

HTTP

Http command takes method, url, header and body in order to make an http request

Full Example:

HTTP POST "https://hooks.slack.com/services/SLACK_TOKEN" 
     HEADER "User-Agent:Microspector
     Content-type: application/json"
     BODY '{ "text":"Hello World!" }'
     INTO  Result 

Basic Example:

HTTP GET "https://microspector.com/test.json" INTO  result 

this command basically tries to fetch the url and put an &HttpResult into result variable an HttpResult type has a few handy property that can be used for future commands like;

type HttpResult struct {
	Took          int64
	Content       string
	Json          interface{}
	Headers       map[string]string
	StatusCode    int
	ContentLength int
	Error         string
}

ASSERT

Assert is an assertion command, takes an expression and does a thruty check to mark it is failed or succeeded. Different assertion commands are just to categorize the failures.

ASSERT  result.Json.boolean  EQUALS true

MUST

Must is an assertion command, takes an expression and does a thruty check to mark it is failed or succeeded.

MUST  result.StatusCode  EQUALS 200

SHOULD

Should is an assertion command, takes an expression and does a thruty check to mark it is failed or succeeded

SHOULD  result.Took  < 900 

DEBUG

Debug is used to printout variables with its structure, following example will just print the content to the stdout

DEBUG  result.Content 

END

End takes optional boolean expression. It just skips if thruty fails when its used without parameter. When the given expression passes thruty check it ends the execution.

END WHEN  result.Json.boolean  EQUALS false

INCLUDE

Include takes a file path as a parameter and parses in at runtime in the same context.

INCLUDE "tasks/sub-commands.msf"

SLEEP

Include an integer in milliseconds and blocks the execution until then

SLEEP 500

Contributing

Any contributions are more than welcome. Create issues as proposal if you have any suggestions. Or even better, just fork, do your changes and send pull requests. Just make sure all tests pass using make test command before sending a pull request.