report

Documentation

Index

• Variables
• func GenerateReports(dirPath string, queryPath string, outputPath string, reportFormat string) error
• func ListAvailableReports(queryPath string) error
• func ReadFilesAndConcat(dir string) (results []interface{}, err error)

Variables

var Cmd = &cobra.Command{
	Use:   "report",
	Short: "Generate inventory reports based on CAI outputs in a directory.",
	Long: `Generate inventory reports for resources in Cloud Asset Inventory (CAI) output files, with reports defined in rego (in '<path_to_cloud-foundation-toolkit>/reports/sample' folder).

	Example:
	  cft report --query-path <path_to_cloud-foundation-toolkit>/reports/sample \
		--dir-path <path-to-directory-containing-cai-export> \
		--report-path <path-to-directory-for-report-output>
	`,

	Args: cobra.NoArgs,

	RunE: func(cmd *cobra.Command, args []string) error {
		err := GenerateReports(flags.dirName, flags.queryPath, flags.outputPath, viper.GetString("report-format"))
		if err != nil {
			return err
		}
		return nil
	},
}

Cmd represents the base report command

Functions

func GenerateReports

func GenerateReports(dirPath string, queryPath string, outputPath string, reportFormat string) error

GenerateReports takes raw CAI exports from <dirPath> directory, run rego queries defined <queryPath> directory, and generate output of <reportFormat> in <outputPath> directory

func ListAvailableReports

func ListAvailableReports(queryPath string) error

ListAvailableReports lists the names of available reports in queryPath

func ReadFilesAndConcat

func ReadFilesAndConcat(dir string) (results []interface{}, err error)

ReadFilesAndConcat reads json files in a directory that are one object per row, and concats all objects into one single array