Merge pull request #4 from peopledoc/feature/query-inventory

Add `ansible list` command

Author: Nicolas Sterchele

.gitignore

@@ -11,8 +11,8 @@
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
 
+/pkg
 bin/
-pkg/
 
 # Editor files
 *.swp

Makefile

@@ -14,17 +14,17 @@ GOGENERATE=$(GOCMD) generate
 GOTEST=$(GOCMD) test
 GOBUILDFLAGS= "-trimpath"
 
+.PHONY: build
+build:
+	$(GOBUILD) -o $(BINDIR)/$(BINNAME) -v $(GOBUILDFLAGS)
+
 .PHONY: devel-deps
 devel-deps:
 	@for tool in $(EXTERNAL_TOOLS) ; do \
       echo "Installing $$tool" ; \
       GO111MODULE=off go get $$tool; \
     done
 
-.PHONY: build
-build:
-	$(GOBUILD) -o $(BINDIR)/$(BINNAME) -v $(GOBUILDFLAGS)
-
 .PHONY: test
 test:
 	$(GOTEST) -v ./...

cmd/ansible.go

@@ -1,7 +1,9 @@
 package cmd
 
 import (
+	"bufio"
 	"fmt"
+	"io"
 	"jarvis/internal/pkg/ansible"
 	"jarvis/internal/pkg/command"
 	"jarvis/internal/pkg/environment"
@@ -11,39 +13,62 @@ import (
 	"github.com/spf13/viper"
 )
 
+//Ansible flags
+var (
+	HideDiff   bool
+	BecomeSudo bool
+)
+
+//Playbook flags
 var (
-	HideDiff             bool
 	CheckModeDeactivated bool
-	CheckModeEnabled     bool
-	BecomeSudo           bool
 	JoinInventories      bool
 )
 
+//Run flags
+var (
+	CheckModeEnabled bool
+	ModuleName       string
+	ModuleArg        string
+	HostPattern      string
+)
+
+//Inventory flags
 var (
-	ModuleName  string
-	ModuleArg   string
-	HostPattern string
+	ListGroup     bool
+	HostGroupName string
+	WithParent    bool
 )
 
 func init() {
 	rootCmd.AddCommand(ansibleCmd)
-	ansibleCmd.AddCommand(playCmd)
+	//AnsibleCmd
 	ansibleCmd.PersistentFlags().BoolVar(&HideDiff, "nodiff", false,
 		"Hide diff")
 	ansibleCmd.PersistentFlags().BoolVarP(&BecomeSudo, "become", "b", false,
 		"Become sudo")
+
+	//PlaybookCmd
 	playCmd.Flags().BoolVar(&CheckModeDeactivated, "nocheck", false,
 		"Deactivate check mode")
 	playCmd.Flags().BoolVar(&JoinInventories, "join-inventories", false,
 		"Join platforms inventories")
+	ansibleCmd.AddCommand(playCmd)
 
-	ansibleCmd.AddCommand(runCmd)
+	//RunCmd
 	runCmd.Flags().StringVarP(&ModuleName, "module", "m", "shell", "Ansible module name")
 	runCmd.Flags().StringVarP(&ModuleArg, "args", "a", "", "Ansible module arg")
 	runCmd.Flags().StringVarP(&HostPattern, "target", "t", "", "Ansible host-pattern")
 	runCmd.Flags().BoolVar(&CheckModeEnabled, "check", false,
 		"Enable check mode")
 	runCmd.MarkFlagRequired("target")
+	ansibleCmd.AddCommand(runCmd)
+
+	//InventoryCmd
+	inventoryCmd.Flags().BoolVarP(&WithParent, "with-parent", "W", false, "Query with parent group")
+	inventoryCmd.Flags().BoolVarP(&ListGroup, "group", "G", false, "List group name (mutually exclusive with --host)")
+	inventoryCmd.Flags().StringVarP(&HostGroupName, "host", "H", "", "List host by group name (mutually exclusive with --group)")
+	ansibleCmd.AddCommand(inventoryCmd)
 }
 
 //usage: jarvis ansible
@@ -148,3 +173,85 @@ var playCmd = &cobra.Command{
 		return nil
 	},
 }
+
+//usage: jarvis ansible list
+//returns:
+// --group(bool) >> list groups name
+// --hosts(string) >> hosts by group
+var inventoryCmd = &cobra.Command{
+	Use:   "list",
+	Short: "Query inventory",
+	PreRunE: func(cmd *cobra.Command, args []string) error {
+		//checking exclusivity
+		if ListGroup && HostGroupName != "" {
+			return fmt.Errorf("--group and --hosts are mutually exclusive")
+		}
+
+		return nil
+	},
+	RunE: func(cmd *cobra.Command, args []string) error {
+		envsPath := viper.GetString("environments.path")
+
+		allInventories, err := environment.GetFullPathInventoriesFromEnvironments(envsPath, *environments)
+		if err != nil {
+			return err
+		}
+
+		var invReaders []io.Reader
+		for _, invs := range allInventories {
+			for _, inv := range invs {
+				if !fileExists(inv) {
+					return fmt.Errorf("the %v file does not exist", inv)
+				}
+				f, err := os.Open(inv)
+				if err != nil {
+					return err
+				}
+				invReaders = append(invReaders, bufio.NewReader(f))
+
+				if isDebug {
+					fmt.Println(inv)
+				}
+			}
+		}
+		//to concatenate all files to one reader
+		r := io.MultiReader(invReaders...)
+		manipulator := ansible.InitInventoryManipulator(r)
+
+		if ListGroup {
+			groups, err := manipulator.GetGroupsName(WithParent)
+			if err != nil {
+				return err
+			}
+			//I know it is a bit odd but Jarvis is learning
+			//be nice with him :)
+			for _, g := range groups {
+				fmt.Println(g)
+			}
+
+			return nil
+		}
+
+		if HostGroupName != "" {
+			hosts, err := manipulator.GetHostsByGroupName(HostGroupName)
+			if err != nil {
+				return err
+			}
+			for _, h := range hosts {
+				fmt.Println(h)
+			}
+
+			return nil
+		}
+
+		return nil
+	},
+}
+
+func fileExists(filename string) bool {
+	info, err := os.Stat(filename)
+	if os.IsNotExist(err) {
+		return false
+	}
+	return !info.IsDir()
+}

cmd/root.go

@@ -44,6 +44,7 @@ func init() {
 		StringVarP(&envName, "env", "e", "", "Environment name, syntax(type.env.platform)")
 	rootCmd.PersistentFlags().
 		BoolVar(&isDebug, "debug", false, "debug mode")
+	rootCmd.MarkPersistentFlagRequired("env")
 
 	cobra.OnInitialize(initConfig)
 }

go.mod

@@ -5,6 +5,7 @@ go 1.13
 require (
 	github.com/golang/mock v1.3.1
 	github.com/pelletier/go-toml v1.6.0 // indirect
+	github.com/relex/aini v0.0.0-00010101000000-000000000000
 	github.com/spf13/afero v1.2.2 // indirect
 	github.com/spf13/cast v1.3.1 // indirect
 	github.com/spf13/cobra v0.0.5
@@ -16,3 +17,5 @@ require (
 	gopkg.in/ini.v1 v1.51.1 // indirect
 	gopkg.in/yaml.v2 v2.2.7
 )
+
+replace github.com/relex/aini => ./internal/pkg/aini

go.sum

@@ -39,6 +39,8 @@ github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5y
 github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
 github.com/google/btree v1.0.0/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ=
 github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M=
+github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 h1:El6M4kTTCOh6aBiKaUGG7oYTSPP8MxqL4YI3kZKwcP4=
+github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510/go.mod h1:pupxD2MaaD3pAXIBCelhxNneeOaAeabZDe5s4K6zSpQ=
 github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1 h1:EGx4pi6eqNxGaHF6qqu48+N2wcFQ5qg5FXgOdqsJ5d8=
 github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1/go.mod h1:wJfORRmW1u3UXTncJ5qlYoELFm8eSnnEO6hX4iZ3EWY=
 github.com/gorilla/websocket v1.4.0/go.mod h1:E7qHFY5m1UJ88s3WnNqhKjPHQ0heANvMoAMk2YaljkQ=

internal/pkg/aini/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2020 RELEX Oy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

internal/pkg/aini/README.md

@@ -0,0 +1,106 @@
+# aini
+
+Go library for Parsing Ansible inventory files.  
+We are trying to follow the logic of Ansible parser as close as possible.
+
+Documentation on ansible inventory files can be found here:  
+https://docs.ansible.com/ansible/latest/user_guide/intro_inventory.html
+
+## Supported features:
+- [X] Variables
+- [X] Host patterns
+- [X] Nested groups
+
+## Public API
+```godoc
+package aini // import "github.com/relex/aini"
+
+
+TYPES
+
+type Group struct {
+        Name     string
+        Vars     map[string]string
+        Hosts    map[string]*Host
+        Children map[string]*Group
+        Parents  map[string]*Group
+}
+    Group represents ansible group
+
+func GroupMapListValues(mymap map[string]*Group) []*Group
+    GroupMapListValues transforms map of Groups into Group list
+
+type Host struct {
+        Name   string
+        Port   int
+        Vars   map[string]string
+        Groups map[string]*Group
+}
+    Host represents ansible host
+
+func HostMapListValues(mymap map[string]*Host) []*Host
+    HostMapListValues transforms map of Hosts into Host list
+
+type InventoryData struct {
+        Groups map[string]*Group
+        Hosts  map[string]*Host
+}
+    InventoryData contains parsed inventory representation Note: Groups and
+    Hosts fields contain all the groups and hosts, not only top-level
+
+func Parse(r io.Reader) (*InventoryData, error)
+    Parse using some Reader
+
+func ParseFile(f string) (*InventoryData, error)
+    ParseFile parses Inventory represented as a file
+
+func ParseString(input string) (*InventoryData, error)
+    ParseString parses Inventory represented as a string
+
+func (inventory *InventoryData) GroupsToLower()
+    GroupsToLower transforms all group names to lowercase
+
+func (inventory *InventoryData) HostsToLower()
+    HostsToLower transforms all host names to lowercase
+
+func (inventory *InventoryData) Match(m string) []*Host
+    Match looks for a hosts that match the pattern
+
+func (inventory *InventoryData) Reconcile()
+    Reconcile ensures inventory basic rules, run after updates
+
+```
+
+## Usage example
+```go
+import (
+    "strings"
+    
+    "github.com/relex/aini"
+)
+
+func main() {
+    // Load from string example
+    inventoryReader := strings.NewReader(`
+	host1:2221
+	[web]
+	host2 ansible_ssh_user=root
+    `)
+    var inventory InventoryData = aini.Parse(inventoryReader)
+
+    // Querying hosts
+    _ = inventory.Hosts["host1"].Name == "host1"  // true
+    _ = inventory.Hosts["host1"].Port == 2221     // true
+    _ = inventory.Hosts["host2"].Name == "host2"] // true
+    _ = inventory.Hosts["host2"].Post == 22]      // true
+    
+    _ = len(inventory.Hosts["host1"].Groups) == 2 // all, ungrouped
+    _ = len(inventory.Hosts["host2"].Groups) == 2 // all, web
+    
+    _ = len(inventory.Match("host*")) == 2        // host1, host2
+
+    _ = // Querying groups
+    _ = inventory.Groups["web"].Hosts[0].Name == "host2" // true
+    _ = len(inventory.Groups["all"].Hosts) == 2          // true
+}
+```