Build CI that fails if RustScan takes too long (we already have the timer implemented)

[bee-san]

Hello Spoopy Hackers ghost

Welcome to Hacktoberfest 🧙‍♀️

This issue is exclusively for Hacktoberfest! :)

Our contributing guidelines are here:
https://github.com/RustScan/RustScan/wiki/Contributing

What this issue is

Problem

RustScan is designed to be fast. But sometimes we make changes which make RustScan very slow.

Solution

We would like continuous integration that tests the speed of RustScan and fails if it's under a certain time limit. For example:

command | time in seconds
rustscan --no-nmap 127.0.0.1 - 3 seconds
rustscan --no-nmap -u 5000 -b 2500 google.com - 28 seconds
rustscan --no-nmap -u 5000 -b 2500 example.com - 28 seconds
rustscan --no-nmap -u 5000 -b 2500 rustscan.cmnatic.co.uk - 26 seconds

If any of these tests are slower than the times mentioned, fail the CI.

This is a benchmark test -- however if you can make sure a port is open. At least port 80. You can get a list of ports by running rustscan with --greppable.

And from here you can check the open ports.

We have Rust code for measuring the timing of RustScan here:
https://github.com/RustScan/RustScan/blob/master/src/benchmark/mod.rs

However, you may use Python if you'd like. So long as the CI fails / passes correctly.

We use Travis CI for our CI, however you can use GitHub actions if you'd like.

You can either call RustScan via a Rust Test, or using Python to call RustScan via the terminal (but you will have to write CI that downloads RustScan's latest branch and builds it).

Code Expert

As part of this issue you will get someone familiar with the code to answer questions on it. The timing benchmark is written by @bergabman , so any questions about that please ask them.

For CI please speak to @bee-san or @CMNatic .

EDIT

I think https://crates.io/crates/criterion works very well here.

[issue-label-bot]

Issue-Label Bot is automatically applying the label feature_request to this issue, with a confidence of 0.61. Please mark this comment with 👍 or 👎 to give our bot feedback!

Links: app homepage, dashboard and code for this bot.

[bofh69]

I'll give it a try.

I don't think criterion would work so well here. It is made to measure the performance of small functions, running it hundred of times, filtering out noise from other programs running on the computer.

If a hard limit is all that is needed, maybe it would be better to add a new option to RustScan to make it timeout the whole scanning and then simply run it from the travis configuration with that option?

[bofh69]

It seems the suggested timeout values are too low or there have already been a regression.

When running them at my computer, the scans take just over 40 seconds.

[bofh69]

Running on travis, arm64 linux gave these times:

Running: target/debug/rustscan: --greppable --no-nmap -u 5000 -b 2500 example.com
time: 41.0s

Running: target/debug/rustscan: --greppable --no-nmap -u 5000 -b 2500 google.com
time: 41.0s

Running: target/debug/rustscan: --greppable --no-nmap 127.0.0.1
time: 17.1s

Running: target/debug/rustscan: --greppable --no-nmap -u 5000 -b 2500 rustscan.cmnatic.co.uk
time: 41.0s