aboutsummaryrefslogtreecommitdiff
path: root/rubric_config.go
blob: 887bbb0de9f442abbeca3190d5b07444241d36cf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
package planr

import (
  "github.com/BurntSushi/toml"
)
/*
  TODO: Every property defined within the defaults currently 
  has to implement the "inherit" method to conditionally inherit a
  property in relation to a parent. (Ostensibly so that test cases
  can override default configuration.) This is pedantic because 
  most properties will end up writing boilerplate amounting to:

  parent.inherit()
  ...
  if config.property == nil {
    config.property = config.parent.property
  }

  This library provides copying behavior between structs
  with common properties using reflection. It seems like
  a slight abuse of reflection... But, it could be 
  retro-fitted to implement this behavior if a "onlyCopyZeroFields"
  option was provided.

  > "github.com/jinzhu/copier"
*/

// Inheritable configuration can inherit properties defined in a
// defaults file. This happens on a per-directory basis so multiple
// tests can share common configuration.
//
// The parent will always be of the same type as the child and an
// assertion is required to define the proper behavior.
type InheritableConfig interface {
  Inherit(parent interface{})
}


// Program-wide configuration which is recognized
// in defaults.toml
type Defaults struct {
  Points      *float32
  Adapter     *string

  /*
    The TOML library only parses exported fields.
    The Adapters field is an intermediate mapping
    individual adapters to their locally defined
    configuration. After they individually process
    the configuration, it is mapped to the adapters_
    field.

    See: decodeAdapters()
  */
  Adapters    *map[string] toml.Primitive
  adapters_    map[string] InheritableConfig

  /*
    The configs_ field is necessary to property
    implement the Inherit method using a common
    interface. 
  */
  configs_    *[]AdapterConfig
}


// The default configuration must be able in inherit from
// other defaults further up the tree
//
// This provides multiple levels of configurability
func (child *Defaults) Inherit(p interface{}) {
  parent := p.(Defaults)

  // Inherit properties which haven't been configured
  if child.Points == nil {
    child.Points = parent.Points;
  }

  if child.Adapter == nil {
    child.Adapter = parent.Adapter;
  } 

  // Call the inherit method as defined by the adapters
  // If an adapter is undefined, inherit the parent configuration
  //
  // _configs represents all adapters (registered to a runner)
  for _, adapter := range *child.configs_ {
    parent_adapter, parent_exists := parent.adapters_[adapter.Name]
    child_adapter,  child_exists  := child.adapters_[adapter.Name]

    if parent_exists {
      if child_exists {
        child_adapter.Inherit(parent_adapter)
      } else {
        child.adapters_[adapter.Name] = parent_adapter 
      }
    }
  }
}

// Parses the intermediate adapters Adapters containing TOML primitives 
// according to methods registered with the runner
// Once parsed, they are stored alongside the registered name to determine
// which adapter will receive the configuration
func (defaults *Defaults) decodeAdapters(
  adapters []AdapterConfig,
  asDefault bool,
) error {
  defaults.configs_ = &adapters
  defaults.adapters_ = make(map[string]InheritableConfig)

  if defaults.Adapters != nil {
    for _, config := range adapters {
      primitive, exists := (*defaults.Adapters)[config.Name]
    
      if exists {
        var parsed InheritableConfig
        var err error
        if asDefault {
          parsed, err = config.ParseDefaultConfig(primitive)
        } else {
          parsed, err = config.ParseConfig(primitive)
        }

        if err != nil {
          return err
        }

        defaults.adapters_[config.Name] = parsed
      }
    }
  }

  return nil
}

// Decode defaults.toml
func DecodeDefaults(path string, adapterCfg []AdapterConfig) (Defaults, error) {
  defaults := Defaults { }

  if _, err := toml.DecodeFile(path, &defaults); err != nil {
    return defaults, err
  }

  if err := defaults.decodeAdapters(adapterCfg, true); err != nil {
    return defaults, err
  }


  return defaults, nil
}

// Decode an individual unit
func DecodeConfig(path string, adapterCfg []AdapterConfig) (TestCaseConfig, error) {
  config := TestCaseConfig { }

  if _, err := toml.DecodeFile(path, &config); err != nil {
    return config, nil
  }

  if err := config.decodeAdapters(adapterCfg, false); err != nil {
    return config, err
  }

  return config, nil
}