IP calculator #154

Harisabdullah · 2023-07-24T08:33:42Z

ipinfo calc <expr>: This sub-command allows performing mathematical calculations on integers and IP addresses using infix expressions. It supports operators like (, ), ^, *, /, +, and -. The implementation involves converting IPs to numbers, converting infix expressions to postfix notation, and executing a stack-based algorithm to calculate the result.
Examples:
ipinfo calc '2*(1.1.1.0 + 2)' ipinfo calc '::/2' ipinfo calc '2*2'
ipinfo ip2n: This sub-command converts an IP address to its corresponding numeric representation.
Examples
ipinfo ip2n 192.168.1.1 ipinfo ip2n 2001:0db8:85a3::8a2e:0370:7334
ipinfo n2ip: This sub-command converts a numeric representation to an IP address. It also supports forcing IPv6 if necessary.
Examples:
ipinfo n2ip -6 3232235777
ipinfo n2ip 32335777
ipinfo n2ip6: This sub-command is a forced IPv6 version of the n2ip sub-command.
Example:
ipinfo n2ip6 3232235777

Closes #108

This commit is a part of Issue #108, which involves implementing the IP calculator. Specifically, it introduces the 'ip2n' command to convert IP addresses to their corresponding integers. The 'ip2n' subcommand now supports both IPv4 and IPv6 addresses. Usage: 'my_command ip2n <ip>' Examples: - 'ipinfo ip2n "190.87.89.1"' - 'ipinfo ip2n "2001:0db8:85a3:0000:0000:8a2e:0370:7334"' - 'ipinfo ip2n "2001:0db8:85a3::8a2e:0370:7334"' - 'ipinfo ip2n "::7334"' - 'ipinfo ip2n "7334::"' Fixes: #108

…IP calculator. Specifically, it introduces the 'n2ip' command to convert integers to their corresponding IP addresses. The 'n2ip' command supports both IPv4 and IPv6 addresses. Usage: 'ipinfo n2ip [<opts>] <expr>' Examples: 'ipinfo n2ip "2*2828-1"' 'ipinfo n2ip "190.87.89.1*2"' 'ipinfo n2ip "2001:0db8:85a3:0000:0000:8a2e:0370:7334*6"' Additionally, the '--ipv6' option, when specified, forces conversion to IPv6 address even if the result is within the IPv4 range. This implementation includes helper functions to validate expressions and convert integers to IP addresses. Fixes: #108

…IP calculator. Specifically, it introduces the 'n2ip6' command to convert decimal numbers to IPv6 addresses. Usage: 'ipinfo n2ip6 [<opts>] <expr>' Examples: 'ipinfo n2ip6 "12*121"' 'ipinfo n2ip6 "::2*2' 'ipinfo n2ip6 "192.132.12.32*2"' 'ipinfo n2ip6 "::2+4::"' Fixes: #108

…IP calculator. Specifically, it introduces the 'calc' command to perform arithmetic on IP addresses and numbers Usage: 'ipinfo calc <expr>' Examples: 'ipinfo calc "12*121-(2::*4)"' 'ipinfo calc "::2*2' 'ipinfo calc "192.132.12.32*2"' 'ipinfo calc "::2+4::"' Fixes: #108

…IP calculator. Specifically, it adds entries for 'calc', 'ip2n', 'n2ip', and 'n2ip6' commands in the default help message

…IP calculator. Specifically, it adds entries for 'calc', 'ip2n', 'n2ip', and 'n2ip6' commands in the completions.

…IP calculator. Specifically, it adds cases for 'calc', 'ip2n', 'n2ip', and 'n2ip6' commands in the switch block.

linear · 2023-07-24T08:33:46Z

BE-987 IP calculator

#108

ipinfo/cmd_calc.go

ipinfo/cmd_calc_infix.go

Co-authored-by: awaismslm <[email protected]>

ipinfo/cmd_default.go

Co-authored-by: awaismslm <[email protected]>

ipinfo/cmd_ip2n.go

ipinfo/cmd_n2ip.go

- Added comments

awaismslm

We are almost done. Just a few changes

ipinfo/cmd_calc.go

ipinfo/cmd_ip2n.go

lib/calc_infix.go

lib/cmd_n2ip.go

lib/cmd_n2ip6.go

- Removed unnecessary arguments check in handler functions - Removed whitespaces

awaismslm

Some minor things. Please do the changes.

lib/cmd_calc.go

lib/cmd_n2ip.go

lib/cmd_n2ip6.go

lib/cmd_calc.go

Co-authored-by: awaismslm <[email protected]>

awaismslm

just a minor fix.

lib/cmd_calc.go

awaismslm · 2023-07-31T10:35:42Z

@UmanShahzad Please do the final review. I am done from my side.

Co-authored-by: awaismslm <[email protected]>

UmanShahzad

We can remove the --nocolor flag if color is not relevant to these commands.
My fault on this but, we should really move ip2n, n2ip, n2ip6 into ipinfo tool. These are not "big" enough or commonly used enough CLI use cases to warrant being at the root level. calc is fine at the root for now.
I'll do another round of review soon and actually test it out soon but, does the expression evaluator allow for space-like characters in it? Ideally I can write ipinfo calc '2 * 2' and not get an error.

UmanShahzad · 2023-08-01T01:29:49Z

ipinfo/cmd_calc.go

+	fmt.Printf(
+		`Usage: %s calc <expression> [<opts>]
+
+calc <expression>


Suggested change

calc <expression>

Description:

Yes! the --nocolor flag is unnecessary and it is removed in the latest commit.

Refactor is done, now ip2n, n2ip, n2ip6 are nested inside ipinfo tool.

The calc command is resilient to white-spaces in the input.

ipinfo/cmd_calc.go

ipinfo/cmd_n2ip6.go

ipinfo/cmd_ip2n.go

ipinfo/cmd_default.go

lib/stack.go

UmanShahzad · 2023-08-01T01:41:16Z

lib/stack.go

+	}
+}
+
+// Top Return top element of stack. Return false if stack is empty.


Suggested change

// Top Return top element of stack. Return false if stack is empty.

// Top returns the top element of the stack. Returns empty string if stack is empty.

Note that this isn't exactly the best interface because an empty string could be a real element.

Yes you are right! I solved this by returning a boolean alongside the empty string if stack is empty.
And as far as empty string being a real element is concerned. The way we are deciding if the stack is empty is by using length. So it solves that issue.

UmanShahzad · 2023-08-01T01:43:00Z

lib/stack.go

+}
+
+// Pop Remove top element of stack. Return false if stack is empty.
+func (st *Stack) Pop() bool {


This implementation pops without returning the popped element. Not really ideal...

Fixed. Combined the functionality of Pop and Top into a one function Pop.

lib/ip_str.go

* Centralized regex patterns for `ipv4` and `ipv6` addresses in one place at `regex.go` for better code organization and maintainability. * Improved documentation * Found and solved a bug in `calc` where 2(2) would not work as 2*(2) * Improved Implementation of `Pop` inside `stack.go` and better documentation * Applied other suggestions from the review.

UmanShahzad · 2023-08-03T09:25:57Z

ipinfo/cmd_tool_n2ip6.go

+  and can also evaluate a mathematical expression for conversion.
+
+Examples:
+  %[1]s n2ip "4294967295 + 87"


Wrong cmd name being used

UmanShahzad · 2023-08-03T09:57:04Z

lib/ip_str.go

+// StrIsIPv6Str checks if the given string is an IPv6 address
+func StrIsIPv6Str(expression string) bool {
+	// Compile the regular expression
+	ipV6Regex := regexp.MustCompile(ipV6RgxPattern)


May have had some misunderstanding on this - we wanna compile these globally just once. This will compile it over and over each time redundantly.

Is the issue that in the original grepip spot it was using MustCompilePOSIX and that doesn't work for you in this use case?

UmanShahzad · 2023-08-03T09:57:19Z

lib/regex.go

+var ipV4RgxPattern string
+
+// ipV6RgxPattern is a global variable used to store a regular expression pattern for matching IPv4 addresses.
+var ipV6RgxPattern string


Is rgx a common abbreviation? Usually regex is enough

UmanShahzad · 2023-08-03T09:58:05Z

lib/regex.go

+// GetIpV4RgxPattern returns a regular expression pattern for matching IPv6 addresses.
+// The returned regular expression can be used to validate strings and determine whether they represent
+// valid IPv4 addresses.
+func GetIpV4RgxPattern() string {


You don't really need a function for it, you can just assign the string here directly to the global variable at definition above (and mark it const too)

UmanShahzad · 2023-08-03T10:00:25Z

lib/init.go

@@ -3,4 +3,6 @@ package lib
 func init() {
 	bogonIP4List = GetBogonRange4()
 	bogonIP6List = GetBogonRange6()
+	ipV4RgxPattern = GetIpV4RgxPattern()
+	ipV6RgxPattern = GetIpV6RgxPattern()


Won't be needed here as it's just a string, you can assign it directly

lib/cmd_tool_n2ip6.go

UmanShahzad · 2023-08-03T10:03:27Z

lib/cmd_grepip.go

 	} else {
-		rexp = regexp.MustCompilePOSIX(rexp4 + "|" + rexp6)
+		rexp = regexp.MustCompilePOSIX(ipV4RgxPattern + "|" + ipV6RgxPattern)


No need to even compile it here if we compiled it before at the global level - we can just assign rexp to be the 'correct' global regexp variable

UmanShahzad · 2023-08-03T10:03:50Z

lib/cmd_calc.go

+
+// CmdCalc Function is the handler for the "calc" command.
+func CmdCalc(f CmdCalcFlags, args []string, printHelp func()) error {
+	if len(args) == 0 {


What about the ipinfo calc -h case, is that being handled?

UmanShahzad · 2023-08-03T10:03:57Z

lib/cmd_tool_n2ip.go

+
+// CmdToolN2IP converts a number to an IP address
+func CmdToolN2IP(f CmdToolN2IPFlags, args []string, printHelp func()) error {
+	if len(args) == 0 {


What about the ipinfo tool n2ip -h case, is that being handled?

UmanShahzad · 2023-08-03T10:04:12Z

lib/cmd_tool_n2ip6.go

+
+// CmdToolN2IP6 converts a number to an IPv6 address
+func CmdToolN2IP6(args []string, printHelp func()) error {
+	if len(args) == 0 {


What about the ipinfo tool n2ip6 -h case, is that being handled?

Co-authored-by: Uman Shahzad <[email protected]>

- Fixed Help flags

Co-authored-by: Uman Shahzad <[email protected]>

Does not affect the validation of IPs in calc.

Harisabdullah added 8 commits July 24, 2023 11:48

This commit is a part of Issue #108, which involves implementing the …

17af602

…IP calculator. Specifically, it adds entries for 'calc', 'ip2n', 'n2ip', and 'n2ip6' commands in the default help message

This commit is a part of Issue #108, which involves implementing the …

27e310e

…IP calculator. Specifically, it adds entries for 'calc', 'ip2n', 'n2ip', and 'n2ip6' commands in the completions.

This commit is a part of Issue #108, which involves implementing the …

bdabecf

…IP calculator. Specifically, it adds cases for 'calc', 'ip2n', 'n2ip', and 'n2ip6' commands in the switch block.

refactoring

edd3de9

Harisabdullah requested a review from UmanShahzad July 24, 2023 08:34

awaismslm reviewed Jul 24, 2023

View reviewed changes

ipinfo/cmd_calc.go Outdated Show resolved Hide resolved

awaismslm reviewed Jul 24, 2023

View reviewed changes

ipinfo/cmd_calc.go Outdated Show resolved Hide resolved

awaismslm reviewed Jul 24, 2023

View reviewed changes

ipinfo/cmd_calc.go Outdated Show resolved Hide resolved

awaismslm reviewed Jul 24, 2023

View reviewed changes

ipinfo/cmd_calc.go Show resolved Hide resolved

awaismslm reviewed Jul 24, 2023

View reviewed changes

ipinfo/cmd_calc_infix.go Outdated Show resolved Hide resolved

awaismslm reviewed Jul 24, 2023

View reviewed changes

ipinfo/cmd_calc_infix.go Outdated Show resolved Hide resolved

awaismslm reviewed Jul 24, 2023

View reviewed changes

ipinfo/cmd_calc_infix.go Outdated Show resolved Hide resolved

awaismslm reviewed Jul 24, 2023

View reviewed changes

ipinfo/cmd_calc_infix.go Outdated Show resolved Hide resolved

Harisabdullah and others added 3 commits July 24, 2023 14:07

Update ipinfo/cmd_calc.go

08801dd

Co-authored-by: awaismslm <[email protected]>

Update ipinfo/cmd_calc.go

530454e

Co-authored-by: awaismslm <[email protected]>

Update ipinfo/cmd_calc.go

323b2a4

Co-authored-by: awaismslm <[email protected]>

awaismslm reviewed Jul 24, 2023

View reviewed changes

ipinfo/cmd_default.go Outdated Show resolved Hide resolved

Harisabdullah and others added 4 commits July 24, 2023 14:07

Update ipinfo/cmd_calc.go

2f51394

Co-authored-by: awaismslm <[email protected]>

Update ipinfo/cmd_calc_infix.go

5fa615a

Co-authored-by: awaismslm <[email protected]>

Update ipinfo/cmd_calc_infix.go

444621e

Co-authored-by: awaismslm <[email protected]>

Update ipinfo/cmd_calc_infix.go

dfd3ef8

Co-authored-by: awaismslm <[email protected]>

awaismslm reviewed Jul 24, 2023

View reviewed changes

ipinfo/cmd_ip2n.go Outdated Show resolved Hide resolved

awaismslm reviewed Jul 24, 2023

View reviewed changes

ipinfo/cmd_ip2n.go Outdated Show resolved Hide resolved

awaismslm reviewed Jul 24, 2023

View reviewed changes

ipinfo/cmd_ip2n.go Outdated Show resolved Hide resolved

awaismslm reviewed Jul 24, 2023

View reviewed changes

ipinfo/cmd_n2ip.go Outdated Show resolved Hide resolved

- Declared constant for precision while parsing string to float

92bb8f2

- Added comments

awaismslm suggested changes Jul 27, 2023

View reviewed changes

Harisabdullah added 3 commits July 31, 2023 09:54

- Renamed lib/calc_infix.go to lib/cmd_calc.go

378ac63

- Removed unnecessary arguments check in handler functions - Removed whitespaces

Moved StrIsIPv4Str and StrIsIPv6Str to lib/ip_str.go

50a58ac

Moved StrIsIPv4Str and StrIsIPv6Str to lib/ip_str.go

a28331d

awaismslm suggested changes Jul 31, 2023

View reviewed changes

Harisabdullah and others added 8 commits July 31, 2023 13:13

Update lib/cmd_calc.go

7e652c1

Co-authored-by: awaismslm <[email protected]>

Update lib/cmd_calc.go

52a91f1

Co-authored-by: awaismslm <[email protected]>

Update lib/cmd_calc.go

6ac24da

Co-authored-by: awaismslm <[email protected]>

Update lib/cmd_calc.go

c012c93

Co-authored-by: awaismslm <[email protected]>

Update lib/cmd_calc.go

addd2dd

Co-authored-by: awaismslm <[email protected]>

Update lib/cmd_calc.go

2f77e43

Co-authored-by: awaismslm <[email protected]>

Update lib/cmd_calc.go

5e55a89

Co-authored-by: awaismslm <[email protected]>

Suggested changes applied

aa50cae

awaismslm approved these changes Jul 31, 2023

View reviewed changes

lib/cmd_calc.go Outdated Show resolved Hide resolved

Update lib/cmd_calc.go

8586480

Co-authored-by: awaismslm <[email protected]>

UmanShahzad reviewed Aug 1, 2023

View reviewed changes

Harisabdullah added 3 commits August 1, 2023 14:18

Merge remote-tracking branch 'origin/haris/be-987' into haris/be-987

8efc978

Removed unnecessary color flags

55fa316

UmanShahzad reviewed Aug 3, 2023

View reviewed changes

Harisabdullah and others added 4 commits August 3, 2023 15:33

Update lib/cmd_tool_n2ip.go

5bd8496

Co-authored-by: Uman Shahzad <[email protected]>

- Regex is now global to avoid redundant compilation

ab8fbb0

- Fixed Help flags

Update lib/cmd_tool_n2ip6.go

2644c1f

Co-authored-by: Uman Shahzad <[email protected]>

MustCompilePOSIXinstead of MustCompile.

7fc3cc6

Does not affect the validation of IPs in calc.

UmanShahzad self-requested a review August 8, 2023 09:21

UmanShahzad approved these changes Aug 8, 2023

View reviewed changes

UmanShahzad merged commit b6918d6 into master Aug 8, 2023

UmanShahzad deleted the haris/be-987 branch August 8, 2023 17:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

IP calculator #154

IP calculator #154

Harisabdullah commented Jul 24, 2023 •

edited

Loading

linear bot commented Jul 24, 2023

awaismslm left a comment

awaismslm left a comment

awaismslm left a comment

awaismslm commented Jul 31, 2023

UmanShahzad left a comment

UmanShahzad Aug 1, 2023

Harisabdullah Aug 1, 2023

UmanShahzad Aug 1, 2023

UmanShahzad Aug 1, 2023

Harisabdullah Aug 1, 2023 •

edited

Loading

UmanShahzad Aug 1, 2023

Harisabdullah Aug 1, 2023

UmanShahzad Aug 3, 2023

UmanShahzad Aug 3, 2023

UmanShahzad Aug 3, 2023

UmanShahzad Aug 3, 2023

UmanShahzad Aug 3, 2023

UmanShahzad Aug 3, 2023

UmanShahzad Aug 3, 2023

UmanShahzad Aug 3, 2023

UmanShahzad Aug 3, 2023

	// Top Return top element of stack. Return false if stack is empty.
	// Top returns the top element of the stack. Returns empty string if stack is empty.

IP calculator #154

IP calculator #154

Conversation

Harisabdullah commented Jul 24, 2023 • edited Loading

linear bot commented Jul 24, 2023

awaismslm left a comment

Choose a reason for hiding this comment

awaismslm left a comment

Choose a reason for hiding this comment

awaismslm left a comment

Choose a reason for hiding this comment

awaismslm commented Jul 31, 2023

UmanShahzad left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Harisabdullah Aug 1, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Harisabdullah commented Jul 24, 2023 •

edited

Loading

Harisabdullah Aug 1, 2023 •

edited

Loading