[refactoring] Move config to its own package

Author: g3force

internal/app/controller/config.go internal/app/config/config.gointernal/app/controller/config.go renamed to internal/app/config/config.go

@@ -1,4 +1,4 @@
-package controller
+package config
 
 import (
 	"github.com/pkg/errors"
@@ -7,16 +7,17 @@ import (
 	"time"
 )
 
-// ConfigSpecial holds configs that are different between normal and overtime halves
-type ConfigSpecial struct {
+// Special holds configs that are different between normal and overtime halves
+type Special struct {
 	HalfDuration     time.Duration `yaml:"half-duration"`
 	HalfTimeDuration time.Duration `yaml:"half-time-duration"`
 	TimeoutDuration  time.Duration `yaml:"timeout-duration"`
 	Timeouts         int           `yaml:"timeouts"`
 	BreakAfter       time.Duration `yaml:"break-after"`
 }
 
-type ConfigGeometry struct {
+// Geometry holds sizes of the field and distance for certain rules
+type Geometry struct {
 	FieldLength                     float64 `yaml:"field-length"`
 	FieldWidth                      float64 `yaml:"field-width"`
 	DefenseAreaDepth                float64 `yaml:"defense-area-depth"`
@@ -27,56 +28,56 @@ type ConfigGeometry struct {
 	PlacementOffsetDefenseArea      float64 `yaml:"placement-offset-defense-area"`
 }
 
-// ConfigGame holds configs that are valid for the whole game
-type ConfigGame struct {
-	YellowCardDuration        time.Duration                `yaml:"yellow-card-duration"`
-	DefaultDivision           Division                     `yaml:"default-division"`
-	Normal                    ConfigSpecial                `yaml:"normal"`
-	Overtime                  ConfigSpecial                `yaml:"overtime"`
-	TeamChoiceTimeout         time.Duration                `yaml:"team-choice-timeout"`
-	DefaultGeometry           map[Division]*ConfigGeometry `yaml:"default-geometry"`
-	MultipleCardStep          int                          `yaml:"multiple-card-step"`
-	MultipleFoulStep          int                          `yaml:"multiple-foul-step"`
-	MultiplePlacementFailures int                          `yaml:"multiple-placement-failures"`
-	MaxBots                   map[Division]int             `yaml:"max-bots"`
-	AutoRefProposalTimeout    time.Duration                `yaml:"auto-ref-proposal-timeout"`
+// Game holds configs that are valid for the whole game
+type Game struct {
+	YellowCardDuration        time.Duration          `yaml:"yellow-card-duration"`
+	DefaultDivision           Division               `yaml:"default-division"`
+	Normal                    Special                `yaml:"normal"`
+	Overtime                  Special                `yaml:"overtime"`
+	TeamChoiceTimeout         time.Duration          `yaml:"team-choice-timeout"`
+	DefaultGeometry           map[Division]*Geometry `yaml:"default-geometry"`
+	MultipleCardStep          int                    `yaml:"multiple-card-step"`
+	MultipleFoulStep          int                    `yaml:"multiple-foul-step"`
+	MultiplePlacementFailures int                    `yaml:"multiple-placement-failures"`
+	MaxBots                   map[Division]int       `yaml:"max-bots"`
+	AutoRefProposalTimeout    time.Duration          `yaml:"auto-ref-proposal-timeout"`
 }
 
-// ConfigNetwork holds configs for network communication
-type ConfigNetwork struct {
+// Network holds configs for network communication
+type Network struct {
 	PublishAddress string `yaml:"publish-address"`
 	VisionAddress  string `yaml:"vision-address"`
 }
 
-// ConfigServer holds configs for the available server services
-type ConfigServer struct {
-	AutoRef ConfigServerAutoRef `yaml:"auto-ref"`
-	Team    ConfigServerTeam    `yaml:"team"`
+// Server holds configs for the available server services
+type Server struct {
+	AutoRef ServerAutoRef `yaml:"auto-ref"`
+	Team    ServerTeam    `yaml:"team"`
 }
 
-// ConfigServerAutoRef holds configs for the autoRef server
-type ConfigServerAutoRef struct {
+// ServerAutoRef holds configs for the autoRef server
+type ServerAutoRef struct {
 	Address        string `yaml:"address"`
 	TrustedKeysDir string `yaml:"trusted-keys-dir"`
 }
 
-// ConfigServerTeam holds configs for the team server
-type ConfigServerTeam struct {
+// ServerTeam holds configs for the team server
+type ServerTeam struct {
 	Address        string `yaml:"address"`
 	TrustedKeysDir string `yaml:"trusted-keys-dir"`
 }
 
-// Config structure for the game controller
-type Config struct {
-	Network ConfigNetwork `yaml:"network"`
-	Game    ConfigGame    `yaml:"game"`
-	Server  ConfigServer  `yaml:"server"`
+// Controller structure for the game controller
+type Controller struct {
+	Network Network `yaml:"network"`
+	Game    Game    `yaml:"game"`
+	Server  Server  `yaml:"server"`
 }
 
-// LoadConfig loads a config from given file
-func LoadConfig(fileName string) (config Config, err error) {
+// LoadControllerConfig loads a config from given file
+func LoadControllerConfig(fileName string) (config Controller, err error) {
 
-	config = DefaultConfig()
+	config = DefaultControllerConfig()
 
 	f, err := os.OpenFile(fileName, os.O_RDONLY, 0600)
 	if err != nil {
@@ -96,8 +97,8 @@ func LoadConfig(fileName string) (config Config, err error) {
 	return
 }
 
-// DefaultConfig creates a config with default values
-func DefaultConfig() (c Config) {
+// DefaultControllerConfig creates a config with default values
+func DefaultControllerConfig() (c Controller) {
 	c.Network.PublishAddress = "224.5.23.1:10003"
 	c.Network.VisionAddress = "224.5.23.2:10006"
 	c.Game.YellowCardDuration = 2 * time.Minute
@@ -126,8 +127,8 @@ func DefaultConfig() (c Config) {
 	c.Server.Team.Address = ":10008"
 	c.Server.Team.TrustedKeysDir = "config/trusted_keys/team"
 
-	c.Game.DefaultGeometry = map[Division]*ConfigGeometry{}
-	c.Game.DefaultGeometry[DivA] = new(ConfigGeometry)
+	c.Game.DefaultGeometry = map[Division]*Geometry{}
+	c.Game.DefaultGeometry[DivA] = new(Geometry)
 	c.Game.DefaultGeometry[DivA].FieldLength = 12
 	c.Game.DefaultGeometry[DivA].FieldWidth = 9
 	c.Game.DefaultGeometry[DivA].DefenseAreaDepth = 1.2
@@ -137,7 +138,7 @@ func DefaultConfig() (c Config) {
 	c.Game.DefaultGeometry[DivA].PlacementOffsetTouchLine = 0.2
 	c.Game.DefaultGeometry[DivA].PlacementOffsetDefenseArea = 1.0
 
-	c.Game.DefaultGeometry[DivB] = new(ConfigGeometry)
+	c.Game.DefaultGeometry[DivB] = new(Geometry)
 	c.Game.DefaultGeometry[DivB].FieldLength = 9
 	c.Game.DefaultGeometry[DivB].FieldWidth = 6
 	c.Game.DefaultGeometry[DivB].DefenseAreaDepth = 1

internal/app/controller/config_test.go internal/app/config/config_test.gointernal/app/controller/config_test.go renamed to internal/app/config/config_test.go

@@ -1,13 +1,13 @@
-package controller
+package config
 
 import (
 	"reflect"
 	"testing"
 )
 
 func Test_LoadConfig(t *testing.T) {
-	defConfig := DefaultConfig()
-	loadedConfig, err := LoadConfig("testdata/config.yaml")
+	defConfig := DefaultControllerConfig()
+	loadedConfig, err := LoadControllerConfig("testdata/config.yaml")
 
 	if err != nil {
 		t.Fatal(err)

internal/app/config/division.go

@@ -0,0 +1,8 @@
+package config
+
+type Division string
+
+const (
+	DivA Division = "DivA"
+	DivB Division = "DivB"
+)

internal/app/controller/controller.go

@@ -1,6 +1,7 @@
 package controller
 
 import (
+	"github.com/RoboCup-SSL/ssl-game-controller/internal/app/config"
 	"github.com/RoboCup-SSL/ssl-game-controller/internal/app/rcon"
 	"github.com/RoboCup-SSL/ssl-game-controller/internal/app/vision"
 	"github.com/RoboCup-SSL/ssl-game-controller/pkg/refproto"
@@ -17,7 +18,7 @@ const configFileName = "config/ssl-game-controller.yaml"
 
 // GameController controls a game
 type GameController struct {
-	Config                      Config
+	Config                      config.Controller
 	Publisher                   Publisher
 	ApiServer                   ApiServer
 	AutoRefServer               *rcon.AutoRefServer
@@ -309,20 +310,20 @@ func (c *GameController) timeoutTeamChoice() {
 	}
 }
 
-func loadPublisher(config Config) Publisher {
+func loadPublisher(config config.Controller) Publisher {
 	publisher, err := NewPublisher(config.Network.PublishAddress)
 	if err != nil {
 		log.Printf("Could not start publisher on %v. %v", config.Network.PublishAddress, err)
 	}
 	return publisher
 }
 
-func loadConfig() Config {
-	config, err := LoadConfig(configFileName)
+func loadConfig() config.Controller {
+	cfg, err := config.LoadControllerConfig(configFileName)
 	if err != nil {
 		log.Printf("Could not load config: %v", err)
 	}
-	return config
+	return cfg
 }
 
 // publish publishes the state to the UI and the teams

internal/app/controller/engine.go

@@ -2,6 +2,7 @@ package controller
 
 import (
 	"fmt"
+	"github.com/RoboCup-SSL/ssl-game-controller/internal/app/config"
 	"github.com/RoboCup-SSL/ssl-game-controller/pkg/refproto"
 	"github.com/pkg/errors"
 	"log"
@@ -16,13 +17,13 @@ type Engine struct {
 	State         *State
 	RefereeEvents []RefereeEvent
 	StageTimes    map[Stage]time.Duration
-	config        ConfigGame
+	config        config.Game
 	TimeProvider  func() time.Time
 	History       History
-	Geometry      ConfigGeometry
+	Geometry      config.Geometry
 }
 
-func NewEngine(config ConfigGame) (e Engine) {
+func NewEngine(config config.Game) (e Engine) {
 	e.config = config
 	e.loadStages()
 	e.ResetGame()
@@ -144,7 +145,7 @@ func (e *Engine) CommandForEvent(event *GameEvent) (command RefCommand, forTeam
 
 	forTeam = event.ByTeam().Opposite()
 
-	if e.State.Division == DivA && event.Type == GameEventPlacementFailedByTeamInFavor {
+	if e.State.Division == config.DivA && event.Type == GameEventPlacementFailedByTeamInFavor {
 		for _, e := range e.State.GameEvents {
 			switch e.Type {
 			case
@@ -403,7 +404,7 @@ func (e *Engine) processCommand(c *EventCommand) error {
 func (e *Engine) processModify(m *EventModifyValue) error {
 	// process team-independent modifies
 	if m.Division != nil {
-		if *m.Division == DivA || *m.Division == DivB {
+		if *m.Division == config.DivA || *m.Division == config.DivB {
 			e.State.Division = *m.Division
 		} else {
 			return errors.Errorf("Invalid division: %v", *m.Division)

internal/app/controller/events.go

@@ -3,6 +3,7 @@ package controller
 import (
 	"encoding/json"
 	"fmt"
+	"github.com/RoboCup-SSL/ssl-game-controller/internal/app/config"
 	"log"
 	"reflect"
 	"time"
@@ -113,7 +114,7 @@ type EventModifyValue struct {
 	FoulCounter           *int                          `json:"foulCounter,omitempty"`
 	BallPlacementFailures *int                          `json:"ballPlacementFailures,omitempty"`
 	CanPlaceBall          *bool                         `json:"canPlaceBall,omitempty"`
-	Division              *Division                     `json:"division,omitempty"`
+	Division              *config.Division              `json:"division,omitempty"`
 	AutoContinue          *bool                         `json:"autoContinue,omitempty"`
 	GameEventBehavior     *EventModifyGameEventBehavior `json:"gameEventBehavior,omitempty"`
 	BotSubstitutionIntend *bool                         `json:"botSubstitutionIntend,omitempty"`

internal/app/controller/state.go

@@ -2,6 +2,7 @@ package controller
 
 import (
 	"encoding/json"
+	"github.com/RoboCup-SSL/ssl-game-controller/internal/app/config"
 	"github.com/RoboCup-SSL/ssl-game-controller/pkg/refproto"
 	"github.com/pkg/errors"
 	"time"
@@ -63,13 +64,6 @@ func NewTeam(team refproto.Team) Team {
 	return TeamUnknown
 }
 
-type Division string
-
-const (
-	DivA Division = "DivA"
-	DivB Division = "DivB"
-)
-
 // Stage represents the different stages of a game
 type Stage string
 
@@ -284,7 +278,7 @@ type State struct {
 	MatchTimeStart     time.Time                           `json:"matchTimeStart"`
 	MatchDuration      time.Duration                       `json:"matchDuration"`
 	TeamState          map[Team]*TeamInfo                  `json:"teamState"`
-	Division           Division                            `json:"division"`
+	Division           config.Division                     `json:"division"`
 	PlacementPos       *Location                           `json:"placementPos"`
 	AutoContinue       bool                                `json:"autoContinue"`
 	NextCommand        RefCommand                          `json:"nextCommand"`
@@ -313,7 +307,7 @@ func NewState() (s *State) {
 	*s.TeamState[TeamBlue] = newTeamInfo()
 	s.TeamState[TeamBlue].OnPositiveHalf = !s.TeamState[TeamYellow].OnPositiveHalf
 
-	s.Division = DivA
+	s.Division = config.DivA
 	s.AutoContinue = true
 
 	s.GameEventBehavior = map[GameEventType]GameEventBehavior{}