feat: location ast

Author: adityals

.gitignore

@@ -1,2 +1,3 @@
 vendor
-bin
+bin
+dump.json

README.md

@@ -7,7 +7,11 @@ A nginx config parser
 ## Basic Usage
 Usage:
 ```sh
-go-ngx-config parse -f <NGINX_CONF_FILE>
+# -f          file path location nginx configm, e,g: ./examples/basic/nginx.conf
+# -o          output json file path location, e.g: ./examples/basic/output
+
+
+go-ngx-config parse -f <NGINX_CONF_FILE> -o <OUTPUT_JSON_FILE_DUMP>
 ```
 
 <details>
@@ -98,21 +102,14 @@ go-ngx-config parse -f <NGINX_CONF_FILE>
                 ]
               },
               {
-                "Block": {
-                  "Directives": [
-                    {
-                      "Block": null,
-                      "Name": "root",
-                      "Parameters": [
-                        "html"
-                      ]
-                    }
-                  ]
-                },
                 "Name": "location",
-                "Parameters": [
-                  "/"
-                ]
+                "Modifier": "=",
+                "Match": "/favicon.ico"
+              },
+              {
+                "Name": "location",
+                "Modifier": "",
+                "Match": "/"
               }
             ]
           }
@@ -152,7 +149,7 @@ go-ngx-config parse -f <NGINX_CONF_FILE>
       ]
     }
   ],
-  "Filepath": "examples/basic/nginx.conf"
+  "Filepath": "./examples/basic/nginx.conf"
 }
 ```
 </details>

cmd/go-ngx-config/commands.go

@@ -23,6 +23,7 @@ func NewParseCommand() *cobra.Command {
 	}
 
 	parseCmd.Flags().StringP("file", "f", "", "nginx.conf file location")
+	parseCmd.Flags().StringP("output", "o", "", "output file location")
 
 	return parseCmd
 }

cmd/go-ngx-config/parser_command.go

@@ -2,18 +2,33 @@ package main
 
 import (
 	"encoding/json"
+	"errors"
+	"os"
+	"time"
 
 	"github.com/adityalstkp/go-ngx-config/pkg/cli"
+	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
 func RunParseNgx(cmd *cobra.Command, args []string) error {
+	startTime := time.Now()
+
 	filePath, err := cmd.Flags().GetString("file")
 	if err != nil {
 		return err
 	}
 
-	ast, err := cli.NewNgxConfParser(filePath)
+	outputFilePath, err := cmd.Flags().GetString("output")
+	if err != nil {
+		return err
+	}
+
+	cliOpts := cli.NgxConfParserCliOptions{
+		Filepath: filePath,
+	}
+
+	ast, err := cli.NewNgxConfParser(cliOpts)
 	if err != nil {
 		return err
 	}
@@ -23,7 +38,32 @@ func RunParseNgx(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
-	println(string(ast_json))
+	if outputFilePath != "" {
+		if _, err := os.Stat(outputFilePath); errors.Is(err, os.ErrNotExist) {
+			err := os.MkdirAll(outputFilePath, os.ModePerm)
+			if err != nil {
+				return err
+			}
+		}
+
+		dumpAstJsonFile := outputFilePath + "/dump.json"
+		f, err := os.Create(dumpAstJsonFile)
+		if err != nil {
+			return err
+		}
+		defer f.Close()
+
+		_, err = f.Write(ast_json)
+		if err != nil {
+			return err
+		}
+	} else {
+		println(string(ast_json))
+	}
+
+	elapsed := time.Since(startTime)
+	logrus.Info("Process time: ", elapsed)
+
 	return nil
 
 }

examples/basic/nginx.conf

@@ -22,10 +22,15 @@ http {
 
         error_page 500 502 503 504 /50x.html;
 
+        location = /favicon.ico {
+            root html;
+        }
+
         location / {
             root html;
         }
 
+
     }
 
 }

go.mod

@@ -2,4 +2,7 @@ module github.com/adityalstkp/go-ngx-config
 
 go 1.14
 
-require github.com/spf13/cobra v1.5.0
+require (
+	github.com/sirupsen/logrus v1.9.0
+	github.com/spf13/cobra v1.5.0
+)

go.sum

@@ -1,10 +1,20 @@
 github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/inconshreveable/mousetrap v1.0.0 h1:Z8tu5sraLXCXIcARxBp/8cbvlwVa7Z1NHg9XEKhtSvM=
 github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
+github.com/sirupsen/logrus v1.9.0 h1:trlNQbNUG3OdDrDil03MCb1H2o9nJ1x4/5LYw7byDE0=
+github.com/sirupsen/logrus v1.9.0/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
 github.com/spf13/cobra v1.5.0 h1:X+jTBEBqF0bHN+9cSMgmfuvv2VHJ9ezmFNf9Y/XstYU=
 github.com/spf13/cobra v1.5.0/go.mod h1:dWXEIy2H428czQCjInthrTRUg7yKbok+2Qi/yBIJoUM=
 github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
 github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 h1:0A+M6Uqn+Eje4kHMK80dtF3JCXC4ykBgQG4Fe06QRhQ=
+golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

internal/ast/location.go

@@ -0,0 +1,35 @@
+package ast
+
+import (
+	"errors"
+
+	"github.com/adityalstkp/go-ngx-config/internal/directive"
+)
+
+type Location struct {
+	*directive.Directive
+	Name     string
+	Modifier string
+	Match    string
+}
+
+func NewLocation(directive *directive.Directive) (*Location, error) {
+	location := &Location{
+		Name: "location",
+	}
+
+	if len(directive.Parameters) == 0 {
+		return nil, errors.New("not enough argument in location block")
+	}
+
+	if len(directive.Parameters) == 1 {
+		location.Match = directive.Parameters[0]
+		return location, nil
+	} else if len(directive.Parameters) == 2 {
+		location.Modifier = directive.Parameters[0]
+		location.Match = directive.Parameters[1]
+		return location, nil
+	}
+
+	return location, nil
+}

internal/parser/parser.go

@@ -51,6 +51,9 @@ func newParserFromLexer(lexer *lexer.Lexer) *Parser {
 		"server": func(d *directive.Directive) statement.IDirective {
 			return parser.wrapServer(d)
 		},
+		"location": func(d *directive.Directive) statement.IDirective {
+			return parser.wrapLocation(d)
+		},
 	}
 
 	return parser
@@ -133,3 +136,8 @@ func (p *Parser) wrapServer(directive *directive.Directive) *ast.Server {
 	s, _ := ast.NewServer(directive)
 	return s
 }
+
+func (p *Parser) wrapLocation(directive *directive.Directive) *ast.Location {
+	l, _ := ast.NewLocation(directive)
+	return l
+}

pkg/cli/cli.go

@@ -7,8 +7,8 @@ import (
 	"github.com/adityalstkp/go-ngx-config/internal/parser"
 )
 
-func NewNgxConfParser(file string) (*ast.Config, error) {
-	parser, err := parser.NewParser(file)
+func NewNgxConfParser(cliOpts NgxConfParserCliOptions) (*ast.Config, error) {
+	parser, err := parser.NewParser(cliOpts.Filepath)
 	if err != nil {
 		return nil, err
 	}