feat: treat pairs domain/ip always as uniq. Fixes #71

guumaster · guumaster · commit 9477b29d3581 · 2021-07-13T13:05:10.000+02:00
diff --git a/cmd/hostctl/actions/add_domains_test.go b/cmd/hostctl/actions/add_domains_test.go
@@ -60,4 +60,53 @@ func Test_AddDomains(t *testing.T) {
 				+----------+--------+-----------+----------------+
 `, r.Hostfile())
 	})
+
+	t.Run("Add domains uniq", func(t *testing.T) {
+		r := NewRunner(t, cmd, "add_uniq")
+		defer r.Clean()
+
+		r.Run("hostctl add domains awesome same.domain.loc --ip 3.3.3.3").
+			Run("hostctl add domains awesome same.domain.loc --ip 3.3.3.3").
+			Containsf(`
+				[ℹ] Using hosts file: %s
+
+				[✔] Domains 'same.domain.loc' added.
+
+        +---------+--------+---------+-----------------+
+        | PROFILE | STATUS |   IP    |     DOMAIN      |
+        +---------+--------+---------+-----------------+
+        | awesome | on     | 3.3.3.3 | same.domain.loc |
+        +---------+--------+---------+-----------------+
+			`, r.Hostfile())
+	})
+
+	t.Run("Add domains uniq per profile", func(t *testing.T) {
+		r := NewRunner(t, cmd, "multi_profile")
+		defer r.Clean()
+
+		r.Run("hostctl add domains another same.domain.loc --ip 3.3.3.3").
+			Run("hostctl add domains another same.domain.loc --ip 3.3.3.3").
+			Run("hostctl add domains awesome same.domain.loc --ip 3.3.3.3").
+			Run("hostctl add domains awesome same.domain.loc --ip 3.3.3.3").
+			Run("hostctl list another").
+			Containsf(`
+				[ℹ] Using hosts file: %s
+
+				+---------+--------+---------+-----------------+
+				| PROFILE | STATUS |   IP    |     DOMAIN      |
+				+---------+--------+---------+-----------------+
+				| another | on     | 3.3.3.3 | same.domain.loc |
+				+---------+--------+---------+-----------------+
+			`, r.Hostfile()).
+			Run("hostctl list awesome").
+			Containsf(`
+				[ℹ] Using hosts file: %s
+
+				+---------+--------+---------+-----------------+
+				| PROFILE | STATUS |   IP    |     DOMAIN      |
+				+---------+--------+---------+-----------------+
+				| awesome | on     | 3.3.3.3 | same.domain.loc |
+				+---------+--------+---------+-----------------+
+			`, r.Hostfile())
+	})
 }
diff --git a/cmd/hostctl/actions/add_replace.go b/cmd/hostctl/actions/add_replace.go
@@ -58,10 +58,9 @@ func makeAddReplace(actionFn addRemoveFn) func(cmd *cobra.Command, profiles []st
 	return func(cmd *cobra.Command, profiles []string) error {
 		src, _ := cmd.Flags().GetString("host-file")
 		from, _ := cmd.Flags().GetString("from")
-		uniq, _ := cmd.Flags().GetBool("uniq")
 		in := cmd.InOrStdin()
 
-		p, err := getProfileFromInput(in, from, uniq)
+		p, err := getProfileFromInput(in, from)
 		if err != nil {
 			return err
 		}
@@ -83,7 +82,7 @@ func makeAddReplace(actionFn addRemoveFn) func(cmd *cobra.Command, profiles []st
 	}
 }
 
-func getProfileFromInput(in io.Reader, from string, uniq bool) (*types.Profile, error) {
+func getProfileFromInput(in io.Reader, from string) (*types.Profile, error) {
 	var (
 		r   io.Reader
 		err error
@@ -104,5 +103,5 @@ func getProfileFromInput(in io.Reader, from string, uniq bool) (*types.Profile,
 		return nil, err
 	}
 
-	return parser.ParseProfile(r, uniq)
+	return parser.ParseProfile(r)
 }
diff --git a/cmd/hostctl/actions/add_replace_test.go b/cmd/hostctl/actions/add_replace_test.go
@@ -12,11 +12,26 @@ func Test_Add(t *testing.T) {
 	r := NewRunner(t, cmd, "add")
 	defer r.Clean()
 
-	tmp := r.TempHostfile("source")
-	defer os.Remove(tmp.Name())
-
 	t.Run("Add from file", func(t *testing.T) {
-		r.Runf("hostctl add awesome --uniq --from %s", tmp.Name()).
+		tmp := r.TempHostfile("source")
+		defer os.Remove(tmp.Name())
+		r.Runf("hostctl add awesome --from %s", tmp.Name()).
+			Contains(`
+				+---------+--------+-----------+------------+
+				| PROFILE | STATUS |    IP     |   DOMAIN   |
+				+---------+--------+-----------+------------+
+				| awesome | on     | 127.0.0.1 | localhost  |
+				| awesome | on     | 127.0.0.1 | first.loc  |
+				| awesome | on     | 127.0.0.1 | second.loc |
+				+---------+--------+-----------+------------+
+			`)
+	})
+
+	t.Run("Add from file uniq", func(t *testing.T) {
+		tmp := r.TempHostfile("source")
+		defer os.Remove(tmp.Name())
+		r.Runf("hostctl add awesome --from %s", tmp.Name()).
+			Runf("hostctl add awesome --from %s", tmp.Name()).
 			Contains(`
 				+---------+--------+-----------+------------+
 				| PROFILE | STATUS |    IP     |   DOMAIN   |
diff --git a/cmd/hostctl/actions/helpers_test.go b/cmd/hostctl/actions/helpers_test.go
@@ -116,7 +116,7 @@ func TestReadFromURL(t *testing.T) {
 	r, err := readerFromURL(server.URL)
 	assert.NoError(t, err)
 
-	p, err := parser.ParseProfile(r, true)
+	p, err := parser.ParseProfile(r)
 	assert.NoError(t, err)
 
 	hosts := p.GetAllHostNames()
diff --git a/cmd/hostctl/actions/root.go b/cmd/hostctl/actions/root.go
@@ -101,7 +101,6 @@ func registerCommands(rootCmd *cobra.Command) {
 	addCmd.Flags().StringP("from", "f", "", "file to read")
 	addCmd.PersistentFlags().
 		DurationP("wait", "w", -1, "Enables a profile for a specific amount of time. (example: 5m, 1h)")
-	addCmd.PersistentFlags().BoolP("uniq", "u", false, "only keep uniq domains per IP")
 
 	// remove
 	removeCmd.Flags().Bool("all", false, "Remove all profiles")
@@ -113,7 +112,6 @@ func registerCommands(rootCmd *cobra.Command) {
 	// replace
 	replaceCmd := newReplaceCmd()
 	replaceCmd.Flags().StringP("from", "f", "", "file to read")
-	replaceCmd.Flags().BoolP("uniq", "u", false, "only keep uniq domains per IP")
 
 	// toggle
 	toggleCmd := newToggleCmd()
diff --git a/pkg/file/add_test.go b/pkg/file/add_test.go
@@ -20,7 +20,7 @@ func TestFile_AddProfile(t *testing.T) {
 		assert.NoError(t, err)
 		r := strings.NewReader(`127.0.0.1 added.loc`)
 
-		p, err := parser.ParseProfile(r, true)
+		p, err := parser.ParseProfile(r)
 		assert.NoError(t, err)
 		p.Name = "awesome"
 		p.Status = types.Enabled
@@ -41,7 +41,7 @@ func TestFile_AddProfile(t *testing.T) {
 		assert.NoError(t, err)
 		r := strings.NewReader(`127.0.0.1 added.loc`)
 
-		p, err := parser.ParseProfile(r, true)
+		p, err := parser.ParseProfile(r)
 		assert.NoError(t, err)
 		p.Name = "profile1"
 
@@ -63,7 +63,7 @@ func TestFile_AddProfile(t *testing.T) {
 		assert.NoError(t, err)
 		r := strings.NewReader(`127.0.0.1 added.loc`)
 
-		p, err := parser.ParseProfile(r, true)
+		p, err := parser.ParseProfile(r)
 		assert.NoError(t, err)
 		p.Name = "default"
 
diff --git a/pkg/file/file.go b/pkg/file/file.go
@@ -138,7 +138,7 @@ func (f *File) AddRoutes(name string, routes []*types.Route) error {
 }
 
 // RemoveHostnames removes route information from a given types.
-// also removes the profile if gets empty.
+// also removes the profile if it gets empty.
 func (f *File) RemoveHostnames(name string, routes []string) (bool, error) {
 	p, err := f.GetProfile(name)
 	if err != nil {
diff --git a/pkg/file/file_test.go b/pkg/file/file_test.go
@@ -114,7 +114,7 @@ func TestManagerRoutes(t *testing.T) {
 		assert.NoError(t, err)
 
 		r := strings.NewReader(`3.3.3.4 some.profile.loc`)
-		p, err := parser.ParseProfile(r, true)
+		p, err := parser.ParseProfile(r)
 		assert.NoError(t, err)
 
 		h, _ := mem.OpenFile("/tmp/etc/hosts", os.O_CREATE|os.O_RDWR|os.O_TRUNC, 0644)
diff --git a/pkg/file/replace_test.go b/pkg/file/replace_test.go
@@ -21,7 +21,7 @@ func TestFile_ReplaceProfile(t *testing.T) {
 
 		r := strings.NewReader(`4.4.4.4 replaced.loc`)
 
-		p, err := parser.ParseProfile(r, true)
+		p, err := parser.ParseProfile(r)
 		assert.NoError(t, err)
 		p.Name = "profile1"
 		p.Status = types.Enabled
@@ -42,7 +42,7 @@ func TestFile_ReplaceProfile(t *testing.T) {
 
 		r := strings.NewReader(`4.4.4.4 replaced.loc`)
 
-		p, err := parser.ParseProfile(r, true)
+		p, err := parser.ParseProfile(r)
 		assert.NoError(t, err)
 		p.Name = "awesome"
 		p.Status = types.Enabled
@@ -63,7 +63,7 @@ func TestFile_ReplaceProfile(t *testing.T) {
 
 		r := strings.NewReader(`4.4.4.4 replaced.loc`)
 
-		p, err := parser.ParseProfile(r, true)
+		p, err := parser.ParseProfile(r)
 		assert.NoError(t, err)
 		p.Name = types.Default
 		p.Status = types.Enabled
diff --git a/pkg/parser/parser.go b/pkg/parser/parser.go
@@ -162,7 +162,7 @@ func parseRouteLine(str string) (*types.Route, bool) {
 }
 
 // ParseProfile creates a new profile reading lines from a reader
-func ParseProfile(r io.Reader, uniq bool) (*types.Profile, error) {
+func ParseProfile(r io.Reader) (*types.Profile, error) {
 	p := &types.Profile{}
 	s := bufio.NewScanner(r)
 
@@ -186,11 +186,7 @@ func ParseProfile(r io.Reader, uniq bool) (*types.Profile, error) {
 		}
 	}
 
-	if uniq {
-		p.AddRoutesUniq(routes)
-	} else {
-		p.AddRoutes(routes)
-	}
+	p.AddRoutes(routes)
 
 	return p, nil
 }
diff --git a/pkg/parser/parser_test.go b/pkg/parser/parser_test.go
@@ -63,7 +63,7 @@ func TestNewProfile(t *testing.T) {
 3.3.3.4 some.profile.loc
 3.3.3.4 first.loc
 `)
-		p, err := ParseProfile(r, true)
+		p, err := ParseProfile(r)
 		assert.NoError(t, err)
 		hosts, err := p.GetHostNames("3.3.3.4")
 		assert.NoError(t, err)
@@ -77,11 +77,11 @@ func TestNewProfile(t *testing.T) {
 3.3.3.4 first.loc
 3.3.3.4 first.loc
 `)
-		p, err := ParseProfile(r, false)
+		p, err := ParseProfile(r)
 		assert.NoError(t, err)
 		hosts, err := p.GetHostNames("3.3.3.4")
 		assert.NoError(t, err)
-		assert.Equal(t, []string{"some.profile.loc", "first.loc", "first.loc"}, hosts)
+		assert.Equal(t, []string{"some.profile.loc", "first.loc"}, hosts)
 	})
 }
 
diff --git a/pkg/types/profile.go b/pkg/types/profile.go
@@ -40,12 +40,7 @@ func (p *Profile) AddRoute(route *Route) {
 	p.AddRoutes([]*Route{route})
 }
 
-// AddRouteUniq adds a single route to the profile and removes duplicates
-func (p *Profile) AddRouteUniq(route *Route) {
-	p.AddRoutesUniq([]*Route{route})
-}
-
-// AddRoutes adds a list of routes to the profile
+// AddRoutes adds non duplicated routes to a profile
 func (p *Profile) AddRoutes(routes []*Route) {
 	if p.Routes == nil {
 		p.Routes = map[string]*Route{}
@@ -57,31 +52,14 @@ func (p *Profile) AddRoutes(routes []*Route) {
 			p.appendIP(ip)
 			p.Routes[ip] = &Route{
 				IP:        net.ParseIP(ip),
-				HostNames: r.HostNames,
+				HostNames: uniqueStrings(r.HostNames),
 			}
 		} else {
-			p.Routes[ip].HostNames = append(p.Routes[ip].HostNames, r.HostNames...)
+			p.Routes[ip].HostNames = uniqueStrings(append(p.Routes[ip].HostNames, r.HostNames...))
 		}
 	}
 }
 
-// AddRoutesUniq adds non duplicated routes to a profile
-func (p *Profile) AddRoutesUniq(routes []*Route) {
-	p.AddRoutes(routes)
-
-	done := map[string]bool{}
-
-	for _, r := range routes {
-		ip := r.IP.String()
-		if _, ok := done[ip]; ok {
-			continue
-		}
-
-		p.Routes[ip].HostNames = uniqueStrings(p.Routes[ip].HostNames)
-		done[ip] = true
-	}
-}
-
 // RemoveHostnames removes multiple hostnames of a profile
 func (p *Profile) RemoveHostnames(hostnames []string) {
 	for _, h := range hostnames {
@@ -111,7 +89,7 @@ func (p *Profile) GetHostNames(ip string) ([]string, error) {
 
 // GetAllHostNames returns all hostnames of the profile.
 func (p *Profile) GetAllHostNames() []string {
-	list := []string{}
+	var list []string
 
 	if p.IPList == nil {
 		return list
@@ -153,7 +131,7 @@ func (p *Profile) Render(w io.StringWriter) error {
 		return err
 	}
 
-	// Write to input writer after knowing the profile is well formed
+	// Write to input writer after knowing the profile is well-formed
 	_, err = w.WriteString(tmp.String())
 
 	return err
@@ -176,7 +154,7 @@ func uniqueStrings(xs []string) []string {
 }
 
 func remove(s []string, n string) []string {
-	list := []string{}
+	var list []string
 
 	for _, x := range s {
 		if x != n {
diff --git a/pkg/types/profile_test.go b/pkg/types/profile_test.go
@@ -89,7 +89,7 @@ func TestProfile(t *testing.T) {
 		p := Profile{}
 
 		p.AddRoute(NewRoute("1.1.1.1", "another.loc", "added.loc"))
-		p.AddRouteUniq(NewRoute("1.1.1.1", "added.loc", "third.loc"))
+		p.AddRoute(NewRoute("1.1.1.1", "added.loc", "third.loc"))
 
 		names, err := p.GetHostNames("1.1.1.1")
 		assert.NoError(t, err)

Original file line number	Diff line number	Diff line change
`@@ -58,10 +58,9 @@ func makeAddReplace(actionFn addRemoveFn) func(cmd *cobra.Command, profiles []st`
`58`	`58`	`return func(cmd *cobra.Command, profiles []string) error {`
`59`	`59`	`src, _ := cmd.Flags().GetString("host-file")`
`60`	`60`	`from, _ := cmd.Flags().GetString("from")`
`61`		`- uniq, _ := cmd.Flags().GetBool("uniq")`
`62`	`61`	`in := cmd.InOrStdin()`
`63`	`62`
`64`		`- p, err := getProfileFromInput(in, from, uniq)`
	`63`	`+ p, err := getProfileFromInput(in, from)`
`65`	`64`	`if err != nil {`
`66`	`65`	`return err`
`67`	`66`	`}`
`@@ -83,7 +82,7 @@ func makeAddReplace(actionFn addRemoveFn) func(cmd *cobra.Command, profiles []st`
`83`	`82`	`}`
`84`	`83`	`}`
`85`	`84`
`86`		`-func getProfileFromInput(in io.Reader, from string, uniq bool) (*types.Profile, error) {`
	`85`	`+func getProfileFromInput(in io.Reader, from string) (*types.Profile, error) {`
`87`	`86`	`var (`
`88`	`87`	`r io.Reader`
`89`	`88`	`err error`
`@@ -104,5 +103,5 @@ func getProfileFromInput(in io.Reader, from string, uniq bool) (*types.Profile,`
`104`	`103`	`return nil, err`
`105`	`104`	`}`
`106`	`105`
`107`		`- return parser.ParseProfile(r, uniq)`
	`106`	`+ return parser.ParseProfile(r)`
`108`	`107`	`}`
Original file line number	Diff line number	Diff line change
`@@ -138,7 +138,7 @@ func (f File) AddRoutes(name string, routes []types.Route) error {`
`138`	`138`	`}`
`139`	`139`
`140`	`140`	`// RemoveHostnames removes route information from a given types.`
`141`		`-// also removes the profile if gets empty.`
	`141`	`+// also removes the profile if it gets empty.`
`142`	`142`	`func (f *File) RemoveHostnames(name string, routes []string) (bool, error) {`
`143`	`143`	`p, err := f.GetProfile(name)`
`144`	`144`	`if err != nil {`
Original file line number	Diff line number	Diff line change
`@@ -162,7 +162,7 @@ func parseRouteLine(str string) (*types.Route, bool) {`
`162`	`162`	`}`
`163`	`163`
`164`	`164`	`// ParseProfile creates a new profile reading lines from a reader`
`165`		`-func ParseProfile(r io.Reader, uniq bool) (*types.Profile, error) {`
	`165`	`+func ParseProfile(r io.Reader) (*types.Profile, error) {`
`166`	`166`	`p := &types.Profile{}`
`167`	`167`	`s := bufio.NewScanner(r)`
`168`	`168`
`@@ -186,11 +186,7 @@ func ParseProfile(r io.Reader, uniq bool) (*types.Profile, error) {`
`186`	`186`	`}`
`187`	`187`	`}`
`188`	`188`
`189`		`- if uniq {`
`190`		`- p.AddRoutesUniq(routes)`
`191`		`- } else {`
`192`		`- p.AddRoutes(routes)`
`193`		`- }`
	`189`	`+ p.AddRoutes(routes)`
`194`	`190`
`195`	`191`	`return p, nil`
`196`	`192`	`}`