Redesign to version v3 #108

elivlo · 2023-02-23T11:32:00Z

I have done some brainstorming on how to redesign this library.
Here are my first ideas on how we could change the API:

I thought that all the different Run functions were too much
- So I broke it down to one Run function
RunAsync, RunWithProgress, RunWithStreamer now needs to be configured before the run. That also includes two new functions:
- ToFile: writes XML directly to a file and outputs normal output to stdout
- Context: adds a context directly to exec command instead of triggering the timeout in code
- Async, Progress and Streamer are the derived functions
This uses a kinda like Builder design pattern

@Ullaakut What do you think of this idea?

Ullaakut

Great work! I think this makes the project much much cleaner and easier to build upon. I have a few suggestions as to how it can be improved even slightly further IMO, as well as some nitpicks.

Thanks again @elivlo ! If you setup a GitHub sponsors account one day I'd be glad to give you some money for your invaluable help on this project.

.github/workflows/test.yml

.gitignore

examples/basic_scan/main.go

examples/basic_scan_progress/main.go

nmap.go

+ Recent functions like Async, Streamer and Progress must be configured + No direct output to file for now + Resume is not working so drop it

elivlo · 2023-04-11T17:23:40Z

@Ullaakut I finished all my work on this branch :)
Would you please take a last look at it before I merge it to master?

+ Decrese progress to every tenth of a second + Make progressIndex more readible

elivlo · 2023-04-11T18:01:45Z

@Ullaakut I finished all my work on this branch :) Would you please take a last look at it before I merge it to master?

Oh, I forgot some hidden comments.

Ullaakut

Some more nitpicks, but this looks good to me :)

README.md

examples/basic_scan/main.go

examples/basic_scan_async/main.go

examples/basic_scan_streamer_interface/main.go

Ullaakut · 2023-04-12T12:57:13Z

go.mod

+	github.com/davecgh/go-spew v1.1.0 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect


For sure those two should not be added. Not sure about the YAML dependency as well but I didn't read everything yet

go.mod

optionsPortOrder.go

+ Before it was required as argument + Change to go1.20 and remove unused module from mod

elivlo added enhancement New feature or request help wanted Extra attention is needed labels Feb 23, 2023

elivlo added this to the Redesign to version v3 milestone Feb 23, 2023

elivlo requested a review from Ullaakut February 23, 2023 11:32

elivlo self-assigned this Feb 23, 2023

elivlo force-pushed the dev/v3 branch from f71ad0c to 7fa739a Compare February 24, 2023 10:44

elivlo marked this pull request as ready for review February 24, 2023 12:01

elivlo marked this pull request as draft February 24, 2023 12:26

elivlo mentioned this pull request Mar 10, 2023

Run function that writes the XML to a file and sends nmap stdout to the console #107

Closed

Ullaakut reviewed Mar 16, 2023

View reviewed changes

elivlo added 12 commits March 26, 2023 00:41

Add vendor directory to gitignore

199b6cd

Rename Option to ArgOption and outsource With* functions

5450a5f

Remove all Run functions and combine them in one function

1c11aeb

+ Recent functions like Async, Streamer and Progress must be configured + No direct output to file for now + Resume is not working so drop it

Readd WithBinaryPath

c802577

Fix Streamer function

fa9daa7

Update host and port filter functions for pointers

49c5fde

Update examples for v3 functions

ac33d13

Remove unused scanner methods and add builder pattern to AddOptions

78153e6

Fix checkStdErr and update nmap tests

beee7c2

Update example and xml tests

35c578b

Install staticcheck v0.3.0 instead of latest in actions

df342bc

Remove cmd, stderr and stdout from Scanner struct

01df0c7

elivlo force-pushed the dev/v3 branch from 9361126 to 01df0c7 Compare March 25, 2023 23:42

Add dots to all comments

e05cad5

elivlo force-pushed the dev/v3 branch from 1967947 to b9a7b40 Compare April 11, 2023 16:18

Add context to warnings in basic_scan example

27a8619

elivlo force-pushed the dev/v3 branch 3 times, most recently from 3e9d564 to 00501bf Compare April 11, 2023 16:36

Remove context from builder and enforce it in NewScanner function

0cd748c

elivlo force-pushed the dev/v3 branch 2 times, most recently from 3846753 to 418a8e0 Compare April 11, 2023 17:21

elivlo marked this pull request as ready for review April 11, 2023 17:24

elivlo force-pushed the dev/v3 branch from ed832eb to 35f9af4 Compare April 11, 2023 17:57

elivlo added 6 commits April 11, 2023 20:00

Apply two suggestions to run function

3c45744

+ Decrese progress to every tenth of a second + Make progressIndex more readible

Make Readme ready for v3

245afd2

Add comments to all public functions

b7be04f

Change major module version to v3 because API is incompatible with v2

0df4013

Add version 3 to Readme

7aeda92

Make streamer example simpler by passing the output to Stdout

0ffaea3

elivlo force-pushed the dev/v3 branch from 35f9af4 to 0ffaea3 Compare April 11, 2023 18:00

Ullaakut approved these changes Apr 12, 2023

View reviewed changes

Sort imports and add warnings to examples

f951c6b

elivlo force-pushed the dev/v3 branch from 50ad454 to f951c6b Compare April 13, 2023 17:18

elivlo added 3 commits April 13, 2023 19:25

Use available interface in decoys example

2dbcad4

Rename ArgOption type back to Option

e947b01

Fix some typos in Readme

612f421

elivlo force-pushed the dev/v3 branch 3 times, most recently from fccf508 to a96b94e Compare April 13, 2023 20:31

elivlo added 4 commits April 13, 2023 22:56

Always return *Run and *warnings[] in Run function

73a7451

+ Before it was required as argument + Change to go1.20 and remove unused module from mod

Fix possible index out of range in WithPorts

52d2111

Update staticcheck and fulfill requirements

4ffab87

Update function that writes to file to also parse the XML

d97e14c

elivlo force-pushed the dev/v3 branch from de17478 to d97e14c Compare April 13, 2023 20:57

Split test into multiple files

07fef9e

elivlo merged commit 0a4c3dc into master Apr 13, 2023

elivlo deleted the dev/v3 branch April 13, 2023 21:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Redesign to version v3 #108

Redesign to version v3 #108

elivlo commented Feb 23, 2023 •

edited

Loading

Ullaakut left a comment

elivlo commented Apr 11, 2023

elivlo commented Apr 11, 2023

Ullaakut left a comment

Ullaakut Apr 12, 2023

		github.com/davecgh/go-spew v1.1.0 // indirect
		github.com/pmezard/go-difflib v1.0.0 // indirect

Redesign to version v3 #108

Redesign to version v3 #108

Conversation

elivlo commented Feb 23, 2023 • edited Loading

Ullaakut left a comment

Choose a reason for hiding this comment

elivlo commented Apr 11, 2023

elivlo commented Apr 11, 2023

Ullaakut left a comment

Choose a reason for hiding this comment

Ullaakut Apr 12, 2023

Choose a reason for hiding this comment

elivlo commented Feb 23, 2023 •

edited

Loading