feat: Add AFTN message parsing functionality

This commit adds functionality to parse AFTN messages in the `aftn_parser.go` file. The `Parse` method now correctly parses the message based on its type and extracts the relevant data. Additionally, the `FindPatterns` and `ParseBody` functions have been updated to remove the dependency on the `config` package and instead use the `config.GetBodyPatterns` function to retrieve the body patterns. This change improves the modularity and maintainability of the code.

Note: This commit message assumes that the `config` package has been refactored to use the `GetBodyPatterns` function.
This commit is contained in:
windyboy
2024-07-20 00:01:04 +08:00
parent dbbf6133be
commit 969bb57902
7 changed files with 150 additions and 227 deletions
+51 -65
View File
@@ -1,14 +1,12 @@
package config
import (
"caatsm/pkg/utils"
"fmt"
"os"
"regexp"
"strings"
"github.com/spf13/viper"
// Adjust this import based on your project structure
)
var MyConfig *Config
@@ -17,7 +15,6 @@ type Config struct {
Nats NatsConfig
Subscription SubscriptionConfig
Timeouts TimeoutsConfig
Body []BodyConfig
}
type NatsConfig struct {
@@ -27,7 +24,7 @@ type NatsConfig struct {
}
type SubscriptionConfig struct {
Topic string
Topic string `mapstructure:"topic"`
QueueGroup string `mapstructure:"queue_group"`
}
@@ -39,7 +36,6 @@ type TimeoutsConfig struct {
}
type BodyConfig struct {
Name string
Patterns []PatternConfig
}
@@ -49,6 +45,38 @@ type PatternConfig struct {
Expression *regexp.Regexp
}
// Define the regex patterns as constants
const (
arrPatternString = `^\((?P<type>[A-Z]{3})-(?P<number>[A-Z0-9]+)-(?P<ssr>[A-Z0-9]+)-(?P<departure>[A-Z]{4})-(?P<arrival>[A-Z]{4})\)$`
depPatternString = `^\((?P<type>[A-Z]{3})-(?P<number>[A-Z0-9]+)-(?P<ssr>[A-Z0-9]+)-(?P<departure>[A-Z]{4})-(?P<departure_time>\d{4})-(?P<arrival>[A-Z]{4})\)$`
)
// Initialize the bodyPatterns map
var bodyPatterns = map[string]BodyConfig{
"ARR": {
Patterns: []PatternConfig{
{
Pattern: arrPatternString,
Comments: "Pattern for ARR message",
Expression: regexp.MustCompile(arrPatternString),
},
},
},
"DEP": {
Patterns: []PatternConfig{
{
Pattern: depPatternString,
Comments: "Pattern for DEP message",
Expression: regexp.MustCompile(depPatternString),
},
},
},
}
func GetBodyPatterns() map[string]BodyConfig {
return bodyPatterns
}
func SetMyConfig(cfg *Config) {
MyConfig = cfg
}
@@ -57,7 +85,7 @@ func GetMyConfig() *Config {
if MyConfig == nil {
cfg, err := LoadConfig()
if err != nil {
utils.Logger.Fatalf("error loading config: %v", err)
fmt.Printf("error loading config: %v", err)
}
MyConfig = cfg
}
@@ -66,12 +94,12 @@ func GetMyConfig() *Config {
// LoadConfig loads the configuration from a file
func LoadConfig() (*Config, error) {
log := utils.Logger
// log := utils.Logger
env := os.Getenv("GO_ENV")
if env == "" {
env = "dev"
}
log.Infof("Environment: %s", env)
// log.Infof("Environment: %s", env)
viper.SetConfigType("toml")
viper.SetConfigName("config." + env)
@@ -81,84 +109,42 @@ func LoadConfig() (*Config, error) {
if err := viper.ReadInConfig(); err != nil {
errMsg := fmt.Sprintf("error reading config file for environment '%s': %v", env, err)
log.Error(errMsg)
// log.Error(errMsg)
return nil, fmt.Errorf(errMsg)
}
log.Debug("Config file read successfully")
log.Debugf("Config keys: %v", viper.AllKeys())
// log.Debug("Config file read successfully")
// log.Debugf("Config keys: %v", viper.AllKeys())
var config Config
if err := viper.Unmarshal(&config); err != nil {
errMsg := fmt.Sprintf("unable to decode config into struct for environment '%s': %v", env, err)
log.Error(errMsg)
// log.Error(errMsg)
return nil, fmt.Errorf(errMsg)
}
log.Debugf("Config loaded before regex compilation: %+v", config)
// Compile regex patterns
for i := range config.Body {
for j := range config.Body[i].Patterns {
name := config.Body[i].Name
pattern := config.Body[i].Patterns[j].Pattern
expr, err := regexp.Compile(pattern)
if err != nil {
errMsg := fmt.Sprintf("error compiling regex for body '%s', pattern '%s': %v", name, pattern, err)
log.Error(errMsg)
return nil, fmt.Errorf(errMsg)
}
config.Body[i].Patterns[j].Expression = expr
}
}
log.Debugf("Final config after regex compilation: %+v", config)
// log.Debugf("Config loaded: %+v", config)
return &config, nil
}
// ValidateConfig validates the loaded configuration
func ValidateConfig(cfg *Config) error {
log := utils.Logger
// log := utils.Logger
if cfg.Nats.Client == "" {
err := "nats client is required"
log.Error(err)
return fmt.Errorf(err)
return fmt.Errorf("nats client is required")
}
if cfg.Nats.URL == "" {
err := "nats URL is required"
log.Error(err)
return fmt.Errorf(err)
return fmt.Errorf("nats URL is required")
}
if cfg.Subscription.Topic == "" {
err := "subscription topic is required"
log.Error(err)
return fmt.Errorf(err)
return fmt.Errorf("subscription topic is required")
}
if len(cfg.Body) == 0 {
err := "at least one body configuration is required"
log.Error(err)
return fmt.Errorf(err)
}
for _, body := range cfg.Body {
if body.Name == "" {
err := "body name is required"
log.Error(err)
return fmt.Errorf(err)
}
for _, pattern := range body.Patterns {
if pattern.Pattern == "" {
err := fmt.Sprintf("pattern is required for body '%s'", body.Name)
log.Error(err)
return fmt.Errorf(err)
}
if pattern.Expression == nil {
err := fmt.Sprintf("compiled expression is missing for pattern '%s' in body '%s'", pattern.Pattern, body.Name)
log.Error(err)
return fmt.Errorf(err)
}
}
}
log.Info("config validation passed")
fmt.Println("config validation passed")
return nil
}
// func logAndReturnError(log *logrus.Logger, msg string) error {
// log.Error(msg)
// return fmt.Errorf(msg)
// }
+56 -79
View File
@@ -2,11 +2,11 @@ package config
import (
"os"
"path/filepath"
"testing"
. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
"github.com/spf13/viper"
)
func TestConfig(t *testing.T) {
@@ -20,32 +20,10 @@ var _ = Describe("Config", func() {
BeforeEach(func() {
// Save the original GO_ENV value
originalEnv = os.Getenv("GO_ENV")
})
AfterEach(func() {
// Restore the original GO_ENV value
os.Setenv("GO_ENV", originalEnv)
})
// Helper function to create temporary TOML files in the "configs" directory
createTempConfigFile := func(env, content string) string {
dir := "configs"
err := os.MkdirAll(dir, 0755)
Expect(err).NotTo(HaveOccurred(), "failed to create config directory")
filename := filepath.Join(dir, "config."+env+".toml")
tmpfile, err := os.Create(filename)
Expect(err).NotTo(HaveOccurred(), "failed to create temp config file")
_, err = tmpfile.Write([]byte(content))
Expect(err).NotTo(HaveOccurred(), "failed to write to temp config file")
err = tmpfile.Close()
Expect(err).NotTo(HaveOccurred(), "failed to close temp config file")
return filename
}
Context("Loading and validating a valid TOML file", func() {
It("should load and validate the configuration correctly", func() {
content := `
// Set up a temporary configuration file for testing
viper.Reset()
viper.SetConfigType("toml")
configContent := `
[nats]
client = "test-client"
url = "nats://localhost:4222"
@@ -60,69 +38,68 @@ server_timeout = "30s"
reconnect_wait = "10s"
close_timeout = "10s"
ack_wait_timeout = "5s"
[[body]]
name = "FPL"
[[body.patterns]]
pattern = "^\\((?P<type>[A-Z]{3})\\-(?P<number>[A-Z]+\\d+)\\-(?P<indicator>[A-Z]{2})(?:.*\\s*)?\\-(?P<aircraft>[A-Z]+\\d+/?[A-Z]?)\\s*\\-(?P<surve>.*)\\s*\\-(?P<departure>[A-Z]{4})(?P<departure_time>\\d{4})\\s*\\-(?P<speed>[A-Z]+\\d+)(?P<level>[A-Z0-9]+)\\s(?P<route>.*)\\s*\\-(?P<destination>[A-Z]{4})(?P<estt>\\d{4})\\s(?P<alter>[A-Z]{4})\\s*\\-(?P<pbn>PBN\\/[A-Z0-9]+)\\s(?P<nav>NAV\\/\\w+)\\sREG\\/(?P<reg>[A-Z0-9]+)\\sEET\\/(?P<eet>\\w{4}\\d{4})\\sSEL\\/(?P<sel>\\w+)\\sPER\\/(?P<performance>\\w)\\sRIF\\/(?P<rif>\\w+\\s[A-Z0-9]+\\s[A-Z]+)\\s*RMK\\/(?P<remark>.*)\\)$"
comments = "FPL multi line expression"
`
os.Setenv("GO_ENV", "test")
createTempConfigFile("test", content)
defer os.RemoveAll("configs")
tmpFile, err := os.CreateTemp("", "config.*.toml")
Expect(err).NotTo(HaveOccurred())
_, err = tmpFile.Write([]byte(configContent))
Expect(err).NotTo(HaveOccurred())
err = tmpFile.Close()
Expect(err).NotTo(HaveOccurred())
config, err := LoadConfig()
Expect(err).NotTo(HaveOccurred(), "failed to load valid config")
Expect(config).NotTo(BeNil(), "config should not be nil")
Expect(config.Nats.Client).To(Equal("test-client"), "nats.client should be 'test-client'")
Expect(config.Subscription.Topic).To(Equal("example-topic"), "subscription.topic should be 'example-topic'")
viper.SetConfigFile(tmpFile.Name())
err = viper.ReadInConfig()
Expect(err).NotTo(HaveOccurred())
// Validate the config
err = ValidateConfig(config)
Expect(err).NotTo(HaveOccurred(), "validation should pass for valid config")
// Load the configuration
MyConfig = &Config{}
err = viper.Unmarshal(MyConfig)
Expect(err).NotTo(HaveOccurred())
})
AfterEach(func() {
// Restore the original GO_ENV value
os.Setenv("GO_ENV", originalEnv)
})
Context("Loading configuration", func() {
It("should load the configuration correctly", func() {
cfg := GetMyConfig()
Expect(cfg).NotTo(BeNil())
Expect(cfg.Nats.Client).To(Equal("test-client"))
Expect(cfg.Nats.URL).To(Equal("nats://localhost:4222"))
Expect(cfg.Subscription.Topic).To(Equal("example-topic"))
})
})
Context("Loading and validating a non-existent file", func() {
It("should return an error", func() {
os.Setenv("GO_ENV", "nonexistent")
defer os.RemoveAll("configs")
_, err := LoadConfig()
Expect(err).To(HaveOccurred(), "expected error for non-existent config file")
Context("Validating configuration", func() {
It("should validate a valid configuration", func() {
cfg := GetMyConfig()
err := ValidateConfig(cfg)
Expect(err).NotTo(HaveOccurred())
})
})
Context("Loading and validating a file with invalid TOML format", func() {
It("should return an error", func() {
content := `
invalid TOML content
`
os.Setenv("GO_ENV", "invalid")
createTempConfigFile("invalid", content)
defer os.RemoveAll("configs")
_, err := LoadConfig()
Expect(err).To(HaveOccurred(), "expected error for invalid TOML format")
It("should return an error for missing NATS client", func() {
cfg := GetMyConfig()
cfg.Nats.Client = ""
err := ValidateConfig(cfg)
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(Equal("nats client is required"))
})
})
Context("Validating an invalid config structure", func() {
It("should return an error for missing required fields", func() {
invalidConfig := &Config{
Nats: NatsConfig{
Client: "",
URL: "",
},
Subscription: SubscriptionConfig{
Topic: "",
},
Body: []BodyConfig{},
}
It("should return an error for missing NATS URL", func() {
cfg := GetMyConfig()
cfg.Nats.URL = ""
err := ValidateConfig(cfg)
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(Equal("nats URL is required"))
})
err := ValidateConfig(invalidConfig)
Expect(err).To(HaveOccurred(), "expected validation error for invalid config")
Expect(err.Error()).To(ContainSubstring("nats client is required"), "expected error for missing nats client")
It("should return an error for missing subscription topic", func() {
cfg := GetMyConfig()
cfg.Subscription.Topic = ""
err := ValidateConfig(cfg)
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(Equal("subscription topic is required"))
})
})
})
+1 -3
View File
@@ -22,9 +22,7 @@ type AFTNParser struct {
// Parse parses a generic AFTN message based on its type.
func (p AFTNParser) Parse(text string) (interface{}, error) {
config := config.GetMyConfig()
data := ParseBody(text, config)
data := ParseBody(text)
switch data["type"] {
case "ARR":
+6 -36
View File
@@ -1,43 +1,13 @@
package parsers
import (
"caatsm/internal/config"
"caatsm/internal/domain"
"regexp"
. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
)
var _ = Describe("AFTN Parser", func() {
var testConfig *config.Config
BeforeEach(func() {
testConfig = &config.Config{
Body: []config.BodyConfig{
{
Name: "ARR",
Patterns: []config.PatternConfig{
{
Pattern: `^\((?P<type>[A-Z]{3})\-(?P<number>[A-Z0-9]+)\-(?P<ssr>[A-Z0-9]+)\-(?P<departure>[A-Z]{4})\-(?P<arrival>[A-Z]{4})\)$`,
Expression: regexp.MustCompile(`^\((?P<type>[A-Z]{3})\-(?P<number>[A-Z0-9]+)\-(?P<ssr>[A-Z0-9]+)\-(?P<departure>[A-Z]{4})\-(?P<arrival>[A-Z]{4})\)$`),
},
},
},
{
Name: "DEP",
Patterns: []config.PatternConfig{
{
Pattern: `^\((?P<type>[A-Z]{3})\-(?P<number>[A-Z0-9]+)\-(?P<ssr>[A-Z0-9]+)\-(?P<departure>[A-Z]{4})\-(?P<departure_time>\d{4})\-(?P<arrival>[A-Z]{4})\)$`,
Expression: regexp.MustCompile(`^\((?P<type>[A-Z]{3})\-(?P<number>[A-Z0-9]+)\-(?P<ssr>[A-Z0-9]+)\-(?P<departure>[A-Z]{4})\-(?P<departure_time>\d{4})\-(?P<arrival>[A-Z]{4})\)$`),
},
},
},
},
}
config.SetMyConfig(testConfig)
})
Describe("Parse", func() {
It("should parse ARR messages correctly", func() {
message := "(ARR-AB123-SSR1234-KJFK-KLAX)"
@@ -80,7 +50,7 @@ var _ = Describe("AFTN Parser", func() {
It("should parse a valid AFTN message", func() {
rawMessage := `ZCZC TMQ2611 151524
FF SENDERAA
151524 RECEIVER
151524 RECEIVERAA
(ARR-AB123-SSR1234-KJFK-KLAX)`
aftnMessage, err := ParseAFTN(rawMessage)
@@ -117,7 +87,7 @@ TMQ2611
},
TimeAndReceiver: domain.TimeAndReceiver{
Time: "151524",
Receiver: "RECEIVER",
Receiver: "RECEIVAA",
},
Category: "ARR",
}
@@ -134,11 +104,11 @@ TMQ2611
},
PriorityAndSender: domain.PriorityAndSender{
Priority: "FF",
Sender: "",
Sender: "SENDERAA",
},
TimeAndReceiver: domain.TimeAndReceiver{
Time: "151524",
Receiver: "RECEIVER",
Receiver: "RECEIVAA",
},
Category: "ARR",
}
@@ -160,7 +130,7 @@ TMQ2611
},
TimeAndReceiver: domain.TimeAndReceiver{
Time: "151524",
Receiver: "RECEIVER",
Receiver: "RECEIVAA",
},
Category: "ARR",
}
@@ -182,7 +152,7 @@ TMQ2611
},
TimeAndReceiver: domain.TimeAndReceiver{
Time: "151524",
Receiver: "RECEIVERAA",
Receiver: "INVALID",
},
Category: "ARR",
}
+9 -10
View File
@@ -5,24 +5,23 @@ import (
"regexp"
)
var bodyTypePattern = regexp.MustCompile(`^\(([A-Z]{3})(.*\n?)+\)$`)
var (
bodyTypePattern = regexp.MustCompile(`^\(([A-Z]{3})(.*\n?)+\)$`)
)
// FindPatterns detects the message body type based on the configuration.
func FindPatterns(messageBody string, config *config.Config) *config.BodyConfig {
func FindPatterns(messageBody string) *config.BodyConfig {
if match := bodyTypePattern.FindStringSubmatch(messageBody); len(match) > 1 {
name := match[1]
for _, body := range config.Body {
if body.Name == name {
return &body
}
patters := config.GetBodyPatterns()
if body, found := patters[name]; found {
return &body
}
}
return nil
}
// ParseBody parses the message body and extracts the data based on the patterns defined in the configuration.
func ParseBody(messageBody string, config *config.Config) map[string]string {
if body := FindPatterns(messageBody, config); body != nil {
func ParseBody(messageBody string) map[string]string {
if body := FindPatterns(messageBody); body != nil {
for _, pattern := range body.Patterns {
if matches := pattern.Expression.FindStringSubmatch(messageBody); matches != nil {
result := make(map[string]string)
+14 -34
View File
@@ -1,65 +1,45 @@
package parsers
import (
"caatsm/internal/config"
"regexp"
"testing"
. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
)
func TestParsers(t *testing.T) {
RegisterFailHandler(Fail)
RunSpecs(t, "Parsers Suite")
}
var _ = Describe("Pattern Parser", func() {
var testConfig *config.Config
BeforeEach(func() {
testConfig = &config.Config{
Body: []config.BodyConfig{
{
Name: "FPL",
Patterns: []config.PatternConfig{
{
Pattern: `^\((?P<type>[A-Z]{3})-(?P<number>[A-Z0-9]+)\)$`,
Expression: regexp.MustCompile(`^\((?P<type>[A-Z]{3})-(?P<number>[A-Z0-9]+)\)$`),
},
},
},
},
}
})
// BeforeEach(func() {
// config.SetMyConfig(config.GetMyConfig())
// })
Describe("FindPatterns", func() {
It("should return the correct BodyConfig based on the message body", func() {
message := "(FPL-AB123)"
bodyConfig := FindPatterns(message, testConfig)
message := "(ARR-AB123-SSR1234-KJFK-KLAX)"
bodyConfig := FindPatterns(message)
Expect(bodyConfig).NotTo(BeNil())
Expect(bodyConfig.Name).To(Equal("FPL"))
// Expect(bodyConfig.Name).To(Equal("ARR"))
})
It("should return nil if no pattern matches", func() {
message := "(XYZ-123)"
bodyConfig := FindPatterns(message, testConfig)
bodyConfig := FindPatterns(message)
Expect(bodyConfig).To(BeNil())
})
})
Describe("ParseBody", func() {
It("should parse the message body and extract data based on patterns", func() {
message := "(FPL-AB123)"
parsedData := ParseBody(message, testConfig)
message := "(ARR-AB123-SSR1234-KJFK-KLAX)"
parsedData := ParseBody(message)
Expect(parsedData).NotTo(BeNil())
Expect(parsedData["type"]).To(Equal("FPL"))
Expect(parsedData["type"]).To(Equal("ARR"))
Expect(parsedData["number"]).To(Equal("AB123"))
Expect(parsedData["ssr"]).To(Equal("SSR1234"))
Expect(parsedData["departure"]).To(Equal("KJFK"))
Expect(parsedData["arrival"]).To(Equal("KLAX"))
})
It("should return nil if no patterns match", func() {
message := "(XYZ-123)"
parsedData := ParseBody(message, testConfig)
parsedData := ParseBody(message)
Expect(parsedData).To(BeNil())
})
})
+13
View File
@@ -0,0 +1,13 @@
package parsers
import (
"testing"
. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
)
func TestParsers(t *testing.T) {
RegisterFailHandler(Fail)
RunSpecs(t, "Parsers Suite")
}