Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added config validation tests #89

Merged
merged 2 commits into from
Feb 6, 2022
Merged

added config validation tests #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1f8b5a
added config validation tests
markusressel Feb 6, 2022
8f2fab9
refactoring
markusressel Feb 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
140 changes: 6 additions & 134 deletions internal/configuration/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
package configuration

import (
"github.com/looplab/tarjan"
"github.com/markusressel/fan2go/internal/ui"
"github.com/markusressel/fan2go/internal/util"
"github.com/mitchellh/go-homedir"
"github.com/spf13/viper"
"os"
Expand Down Expand Up @@ -82,7 +80,12 @@ func ReadConfigFile() {
ui.Info("Using configuration file at: %s", viper.ConfigFileUsed())

LoadConfig()
validateConfig()

err := validateConfig(&CurrentConfig)
if err != nil {
ui.Fatal(err.Error())
}
ui.Fatal("Config validation failed")
}

func LoadConfig() {
Expand All @@ -92,134 +95,3 @@ func LoadConfig() {
ui.Fatal("unable to decode into struct, %v", err)
}
}

func validateConfig() {
config := &CurrentConfig

validateSensors(config)
validateCurves(config)
validateFans(config)
}

func validateSensors(config *Configuration) {
for _, sensorConfig := range config.Sensors {
if sensorConfig.HwMon != nil && sensorConfig.File != nil {
ui.Fatal("Sensor %s: only one sensor type can be used per sensor definition block", sensorConfig.ID)
}

if sensorConfig.HwMon == nil && sensorConfig.File == nil {
ui.Fatal("Sensor %s: sub-configuration for sensor is missing, use one of: hwmon | file", sensorConfig.ID)
}

if !isSensorConfigInUse(sensorConfig, config.Curves) {
ui.Warning("Unused sensor configuration: %s", sensorConfig.ID)
}

if sensorConfig.HwMon != nil {
if sensorConfig.HwMon.Index <= 0 {
ui.Fatal("Sensor %s: invalid index, must be >= 1", sensorConfig.ID)
}
}
}
}

func isSensorConfigInUse(config SensorConfig, curves []CurveConfig) bool {
for _, curveConfig := range curves {
if curveConfig.Function != nil {
// function curves cannot reference sensors
continue
}
if curveConfig.Linear.Sensor == config.ID {
return true
}
}

return false
}

func validateCurves(config *Configuration) {
graph := make(map[interface{}][]interface{})

for _, curveConfig := range config.Curves {
if curveConfig.Linear != nil && curveConfig.Function != nil {
ui.Fatal("Curve %s: only one curve type can be used per curve definition block", curveConfig.ID)
}

if curveConfig.Linear == nil && curveConfig.Function == nil {
ui.Fatal("Curve %s: sub-configuration for curve is missing, use one of: linear | function", curveConfig.ID)
}

if !isCurveConfigInUse(curveConfig, config.Curves, config.Fans) {
ui.Warning("Unused curve configuration: %s", curveConfig.ID)
}

if curveConfig.Function != nil {
var connections []interface{}
for _, curve := range curveConfig.Function.Curves {
connections = append(connections, curve)
}
graph[curveConfig.ID] = connections
}

if curveConfig.Linear != nil {
if len(curveConfig.Linear.Sensor) <= 0 {
ui.Fatal("Curve %s: Missing sensorId", curveConfig.ID)
}
}

}

validateNoLoops(graph)
}

func validateNoLoops(graph map[interface{}][]interface{}) {
output := tarjan.Connections(graph)
for _, items := range output {
if len(items) > 1 {
ui.Fatal("You have created a curve dependency cycle: %v", items)
}
}
}

func isCurveConfigInUse(config CurveConfig, curves []CurveConfig, fans []FanConfig) bool {
for _, curveConfig := range curves {
if curveConfig.Linear != nil {
// linear curves cannot reference curves
continue
}

if util.ContainsString(curveConfig.Function.Curves, config.ID) {
return true
}
}

for _, fanConfig := range fans {
if fanConfig.Curve == config.ID {
return true
}
}

return false
}

func validateFans(config *Configuration) {
for _, fanConfig := range config.Fans {
if fanConfig.HwMon != nil && fanConfig.File != nil {
ui.Fatal("Fans %s: only one fan type can be used per fan definition block", fanConfig.ID)
}

if fanConfig.HwMon == nil && fanConfig.File == nil {
ui.Fatal("Fans %s: sub-configuration for fan is missing, use one of: hwmon | file", fanConfig.ID)
}

if len(fanConfig.Curve) <= 0 {
ui.Fatal("Fan %s: missing curve definition in configuration entry", fanConfig.ID)
}

if fanConfig.HwMon != nil {
if fanConfig.HwMon.Index <= 0 {
ui.Fatal("Fan %s: invalid index, must be >= 1", fanConfig.ID)
}
}
}
}
186 changes: 186 additions & 0 deletions internal/configuration/validation.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,186 @@
package configuration

import (
"errors"
"fmt"
"github.com/looplab/tarjan"
"github.com/markusressel/fan2go/internal/ui"
"github.com/markusressel/fan2go/internal/util"
)

func validateConfig(config *Configuration) error {
err := validateSensors(config)
if err != nil {
return err
}
err = validateCurves(config)
if err != nil {
return err
}
err = validateFans(config)

return err
}

func validateSensors(config *Configuration) error {
for _, sensorConfig := range config.Sensors {
if sensorConfig.HwMon != nil && sensorConfig.File != nil {
return errors.New(fmt.Sprintf("Sensor %s: only one sensor type can be used per sensor definition block", sensorConfig.ID))
}

if sensorConfig.HwMon == nil && sensorConfig.File == nil {
return errors.New(fmt.Sprintf("Sensor %s: sub-configuration for sensor is missing, use one of: hwmon | file", sensorConfig.ID))
}

if !isSensorConfigInUse(sensorConfig, config.Curves) {
ui.Warning("Unused sensor configuration: %s", sensorConfig.ID)
}

if sensorConfig.HwMon != nil {
if sensorConfig.HwMon.Index <= 0 {
return errors.New(fmt.Sprintf("Sensor %s: invalid index, must be >= 1", sensorConfig.ID))
}
}
}

return nil
}

func isSensorConfigInUse(config SensorConfig, curves []CurveConfig) bool {
for _, curveConfig := range curves {
if curveConfig.Function != nil {
// function curves cannot reference sensors
continue
}
if curveConfig.Linear.Sensor == config.ID {
return true
}
}

return false
}

func validateCurves(config *Configuration) error {
graph := make(map[interface{}][]interface{})

for _, curveConfig := range config.Curves {
if curveConfig.Linear != nil && curveConfig.Function != nil {
return errors.New(fmt.Sprintf("Curve %s: only one curve type can be used per curve definition block", curveConfig.ID))
}

if curveConfig.Linear == nil && curveConfig.Function == nil {
return errors.New(fmt.Sprintf("Curve %s: sub-configuration for curve is missing, use one of: linear | function", curveConfig.ID))
}

if !isCurveConfigInUse(curveConfig, config.Curves, config.Fans) {
ui.Warning("Unused curve configuration: %s", curveConfig.ID)
}

if curveConfig.Function != nil {
var connections []interface{}
for _, curve := range curveConfig.Function.Curves {
if curve == curveConfig.ID {
return errors.New(fmt.Sprintf("Curve %s: a curve cannot reference itself", curveConfig.ID))
}
if !curveIdExists(curve, config) {
return errors.New(fmt.Sprintf("Curve %s: no curve definition with id '%s' found", curveConfig.ID, curve))
}
connections = append(connections, curve)
}
graph[curveConfig.ID] = connections
}

if curveConfig.Linear != nil {
if len(curveConfig.Linear.Sensor) <= 0 {
return errors.New(fmt.Sprintf("Curve %s: Missing sensorId", curveConfig.ID))
}

if !sensorIdExists(curveConfig.Linear.Sensor, config) {
return errors.New(fmt.Sprintf("Curve %s: no sensor definition with id '%s' found", curveConfig.ID, curveConfig.Linear.Sensor))
}
}

}

err := validateNoLoops(graph)
return err
}

func sensorIdExists(sensorId string, config *Configuration) bool {
for _, sensor := range config.Sensors {
if sensor.ID == sensorId {
return true
}
}

return false
}

func validateNoLoops(graph map[interface{}][]interface{}) error {
output := tarjan.Connections(graph)
for _, items := range output {
if len(items) > 1 {
return errors.New(fmt.Sprintf("You have created a curve dependency cycle: %v", items))
}
}
return nil
}

func isCurveConfigInUse(config CurveConfig, curves []CurveConfig, fans []FanConfig) bool {
for _, curveConfig := range curves {
if curveConfig.Linear != nil {
// linear curves cannot reference curves
continue
}

if util.ContainsString(curveConfig.Function.Curves, config.ID) {
return true
}
}

for _, fanConfig := range fans {
if fanConfig.Curve == config.ID {
return true
}
}

return false
}

func validateFans(config *Configuration) error {
for _, fanConfig := range config.Fans {
if fanConfig.HwMon != nil && fanConfig.File != nil {
return errors.New(fmt.Sprintf("Fans %s: only one fan type can be used per fan definition block", fanConfig.ID))
}

if fanConfig.HwMon == nil && fanConfig.File == nil {
return errors.New(fmt.Sprintf("Fans %s: sub-configuration for fan is missing, use one of: hwmon | file", fanConfig.ID))
}

if len(fanConfig.Curve) <= 0 {
return errors.New(fmt.Sprintf("Fan %s: missing curve definition in configuration entry", fanConfig.ID))
}

if !curveIdExists(fanConfig.Curve, config) {
return errors.New(fmt.Sprintf("Fan %s: no curve definition with id '%s' found", fanConfig.ID, fanConfig.Curve))
}

if fanConfig.HwMon != nil {
if fanConfig.HwMon.Index <= 0 {
return errors.New(fmt.Sprintf("Fan %s: invalid index, must be >= 1", fanConfig.ID))
}
}
}

return nil
}

func curveIdExists(curveId string, config *Configuration) bool {
for _, curve := range config.Curves {
if curve.ID == curveId {
return true
}
}

return false
}
Loading