driver_validators.go 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386
  1. package preview
  2. import (
  3. "fmt"
  4. "strings"
  5. "github.com/docker/distribution/reference"
  6. "github.com/mitchellh/mapstructure"
  7. "github.com/porter-dev/switchboard/pkg/types"
  8. "k8s.io/apimachinery/pkg/util/validation"
  9. )
  10. func commonValidator(resource *types.Resource) (*Source, *Target, error) {
  11. source := &Source{}
  12. err := mapstructure.Decode(resource.Source, source)
  13. if err != nil {
  14. return nil, nil, fmt.Errorf("for resource '%s': error parsing source: %w", resource.Name, err)
  15. }
  16. target := &Target{}
  17. err = mapstructure.Decode(resource.Target, target)
  18. if err != nil {
  19. return nil, nil, fmt.Errorf("for resource '%s': error parsing target: %w", resource.Name, err)
  20. }
  21. return source, target, nil
  22. }
  23. func deployDriverValidator(resource *types.Resource) error {
  24. source, _, err := commonValidator(resource)
  25. if err != nil {
  26. return err
  27. }
  28. if source.Name == "" {
  29. return fmt.Errorf("for resource '%s': source name cannot be empty", resource.Name)
  30. }
  31. if source.Repo == "" {
  32. if source.Name == "web" || source.Name == "worker" || source.Name == "job" {
  33. source.Repo = "https://charts.getporter.dev"
  34. } else {
  35. source.Repo = "https://chart-addons.getporter.dev"
  36. }
  37. }
  38. if source.Repo == "https://charts.getporter.dev" {
  39. appConfig := &ApplicationConfig{}
  40. err = mapstructure.Decode(resource.Config, appConfig)
  41. if err != nil {
  42. return fmt.Errorf("for resource '%s': error parsing config: %w", resource.Name, err)
  43. }
  44. if appConfig.Build.Method == "" {
  45. return fmt.Errorf("for resource '%s': build method cannot be empty", resource.Name)
  46. } else if appConfig.Build.Method != "docker" &&
  47. appConfig.Build.Method != "pack" &&
  48. appConfig.Build.Method != "registry" {
  49. return fmt.Errorf("for resource '%s': build method must be one of 'docker', 'pack', or 'registry'", resource.Name)
  50. }
  51. if appConfig.Build.Method == "registry" {
  52. if appConfig.Build.Image == "" {
  53. return fmt.Errorf("for resource '%s': image cannot be empty when using the 'registry' build method",
  54. resource.Name)
  55. } else if !strings.Contains(appConfig.Build.Image, "{") {
  56. if len(strings.Split(appConfig.Build.Image, ":")) != 2 {
  57. return fmt.Errorf("for resource '%s': image must be in the format 'image:tag'", resource.Name)
  58. }
  59. // check for valid image
  60. _, err := reference.ParseNamed(appConfig.Build.Image)
  61. if err != nil {
  62. return fmt.Errorf("for resource '%s': error parsing image: %w", resource.Name, err)
  63. }
  64. }
  65. }
  66. for _, eg := range appConfig.EnvGroups {
  67. if errStrs := validation.IsDNS1123Label(eg.Name); len(errStrs) > 0 {
  68. str := fmt.Sprintf("for resource '%s': invalid characters found in env group '%s' name:",
  69. resource.Name, eg.Name)
  70. for _, errStr := range errStrs {
  71. str += fmt.Sprintf("\n * %s", errStr)
  72. }
  73. return fmt.Errorf("%s", str)
  74. }
  75. }
  76. if len(appConfig.Values) > 0 {
  77. if source.Name == "web" {
  78. err := validateWebChartValues(appConfig.Values)
  79. if err != nil {
  80. return fmt.Errorf("for resource '%s': error validating values for web deployment: %w",
  81. resource.Name, err)
  82. }
  83. } else if source.Name == "worker" {
  84. err := validateWorkerChartValues(appConfig.Values)
  85. if err != nil {
  86. return fmt.Errorf("for resource '%s': error validating values for worker deployment: %w",
  87. resource.Name, err)
  88. }
  89. } else if source.Name == "job" {
  90. err := validateJobChartValues(appConfig.Values)
  91. if err != nil {
  92. return fmt.Errorf("for resource '%s': error validating values for job deployment: %w",
  93. resource.Name, err)
  94. }
  95. }
  96. }
  97. } else if source.Repo == "https://chart-addons.getporter.dev" {
  98. if len(resource.Config) > 0 {
  99. if source.Name == "postgresql" {
  100. err := validatePostgresChartValues(resource.Config)
  101. if err != nil {
  102. return fmt.Errorf("for resource '%s': error validating values for postgresql deployment: %w",
  103. resource.Name, err)
  104. }
  105. }
  106. }
  107. }
  108. return nil
  109. }
  110. func buildImageDriverValidator(resource *types.Resource) error {
  111. _, target, err := commonValidator(resource)
  112. if err != nil {
  113. return err
  114. }
  115. if target.AppName == "" {
  116. return fmt.Errorf("for resource '%s': target app_name is missing", resource.Name)
  117. } else {
  118. errStrs := validation.IsDNS1123Label(target.AppName)
  119. if len(errStrs) > 0 {
  120. str := fmt.Sprintf("for resource '%s': invalid characters found in app_name:", resource.Name)
  121. for _, errStr := range errStrs {
  122. str += fmt.Sprintf("\n * %s", errStr)
  123. }
  124. return fmt.Errorf("%s", str)
  125. }
  126. }
  127. driverConfig := &BuildDriverConfig{}
  128. err = mapstructure.Decode(resource.Config, driverConfig)
  129. if err != nil {
  130. return fmt.Errorf("for resource '%s': error parsing config: %w", resource.Name, err)
  131. }
  132. if driverConfig.Build.Method == "" {
  133. return fmt.Errorf("for resource '%s': build method cannot be empty", resource.Name)
  134. } else if driverConfig.Build.Method != "docker" &&
  135. driverConfig.Build.Method != "pack" &&
  136. driverConfig.Build.Method != "registry" {
  137. return fmt.Errorf("for resource '%s': build method must be one of 'docker', 'pack', or 'registry'", resource.Name)
  138. }
  139. if driverConfig.Build.Method == "registry" {
  140. if driverConfig.Build.Image == "" {
  141. return fmt.Errorf("for resource '%s': image cannot be empty when using the 'registry' build method",
  142. resource.Name)
  143. } else if !strings.Contains(driverConfig.Build.Image, "{") {
  144. if len(strings.Split(driverConfig.Build.Image, ":")) != 2 {
  145. return fmt.Errorf("for resource '%s': image must be in the format 'image:tag'", resource.Name)
  146. }
  147. // check for valid image
  148. _, err := reference.ParseNamed(driverConfig.Build.Image)
  149. if err != nil {
  150. return fmt.Errorf("for resource '%s': error parsing image: %w", resource.Name, err)
  151. }
  152. }
  153. }
  154. for _, eg := range driverConfig.EnvGroups {
  155. if errStrs := validation.IsDNS1123Label(eg.Name); len(errStrs) > 0 {
  156. str := fmt.Sprintf("for resource '%s': invalid characters found in env group '%s' name:",
  157. resource.Name, eg.Name)
  158. for _, errStr := range errStrs {
  159. str += fmt.Sprintf("\n * %s", errStr)
  160. }
  161. return fmt.Errorf("%s", str)
  162. }
  163. }
  164. return nil
  165. }
  166. func pushImageDriverValidator(resource *types.Resource) error {
  167. _, target, err := commonValidator(resource)
  168. if err != nil {
  169. return err
  170. }
  171. if target.AppName == "" {
  172. return fmt.Errorf("for resource '%s': target app_name is missing", resource.Name)
  173. } else {
  174. errStrs := validation.IsDNS1123Label(target.AppName)
  175. if len(errStrs) > 0 {
  176. str := fmt.Sprintf("for resource '%s': invalid characters found in app_name:", resource.Name)
  177. for _, errStr := range errStrs {
  178. str += fmt.Sprintf("\n * %s", errStr)
  179. }
  180. return fmt.Errorf("%s", str)
  181. }
  182. }
  183. driverConfig := &PushDriverConfig{}
  184. err = mapstructure.Decode(resource.Config, driverConfig)
  185. if err != nil {
  186. return fmt.Errorf("for resource '%s': error parsing config: %w", resource.Name, err)
  187. }
  188. if driverConfig.Push.Image == "" {
  189. return fmt.Errorf("for resource '%s': image cannot be empty", resource.Name)
  190. } else if !strings.Contains(driverConfig.Push.Image, "{") {
  191. if len(strings.Split(driverConfig.Push.Image, ":")) != 2 {
  192. return fmt.Errorf("for resource '%s': image must be in the format 'image:tag'", resource.Name)
  193. }
  194. // check for valid image
  195. _, err := reference.ParseNamed(driverConfig.Push.Image)
  196. if err != nil {
  197. return fmt.Errorf("for resource '%s': error parsing image: %w", resource.Name, err)
  198. }
  199. }
  200. return nil
  201. }
  202. func updateConfigDriverValidator(resource *types.Resource) error {
  203. source, target, err := commonValidator(resource)
  204. if err != nil {
  205. return err
  206. }
  207. if target.AppName == "" {
  208. return fmt.Errorf("for resource '%s': target app_name is missing", resource.Name)
  209. } else {
  210. errStrs := validation.IsDNS1123Label(target.AppName)
  211. if len(errStrs) > 0 {
  212. str := fmt.Sprintf("for resource '%s': invalid characters found in app_name:", resource.Name)
  213. for _, errStr := range errStrs {
  214. str += fmt.Sprintf("\n * %s", errStr)
  215. }
  216. return fmt.Errorf("%s", str)
  217. }
  218. }
  219. if source.Repo == "" {
  220. if source.Name == "web" || source.Name == "worker" || source.Name == "job" {
  221. source.Repo = "https://charts.getporter.dev"
  222. } else {
  223. source.Repo = "https://chart-addons.getporter.dev"
  224. }
  225. }
  226. driverConfig := &UpdateConfigDriverConfig{}
  227. err = mapstructure.Decode(resource.Config, driverConfig)
  228. if err != nil {
  229. return fmt.Errorf("for resource '%s': error parsing config: %w", resource.Name, err)
  230. }
  231. if driverConfig.UpdateConfig.Image == "" {
  232. return fmt.Errorf("for resource '%s': image cannot be empty", resource.Name)
  233. }
  234. for _, eg := range driverConfig.EnvGroups {
  235. if errStrs := validation.IsDNS1123Label(eg.Name); len(errStrs) > 0 {
  236. str := fmt.Sprintf("for resource '%s': invalid characters found in env group '%s' name:",
  237. resource.Name, eg.Name)
  238. for _, errStr := range errStrs {
  239. str += fmt.Sprintf("\n * %s", errStr)
  240. }
  241. return fmt.Errorf("%s", str)
  242. }
  243. }
  244. if len(driverConfig.Values) > 0 && source.Repo == "https://charts.getporter.dev" {
  245. if source.Name == "web" {
  246. err := validateWebChartValues(driverConfig.Values)
  247. if err != nil {
  248. return fmt.Errorf("for resource '%s': error validating values for web deployment: %w",
  249. resource.Name, err)
  250. }
  251. } else if source.Name == "worker" {
  252. err := validateWorkerChartValues(driverConfig.Values)
  253. if err != nil {
  254. return fmt.Errorf("for resource '%s': error validating values for worker deployment: %w",
  255. resource.Name, err)
  256. }
  257. } else if source.Name == "job" {
  258. err := validateJobChartValues(driverConfig.Values)
  259. if err != nil {
  260. return fmt.Errorf("for resource '%s': error validating values for job deployment: %w",
  261. resource.Name, err)
  262. }
  263. }
  264. }
  265. return nil
  266. }
  267. func randomStringDriverValidator(resource *types.Resource) error {
  268. driverConfig := &RandomStringDriverConfig{}
  269. err := mapstructure.Decode(resource.Config, driverConfig)
  270. if err != nil {
  271. return fmt.Errorf("for resource '%s': error parsing config: %w", resource.Name, err)
  272. }
  273. return nil
  274. }
  275. func envGroupDriverValidator(resource *types.Resource) error {
  276. target := &Target{}
  277. err := mapstructure.Decode(resource.Target, target)
  278. if err != nil {
  279. return fmt.Errorf("for resource '%s': error parsing target: %w", resource.Name, err)
  280. }
  281. config := &EnvGroupDriverConfig{}
  282. err = mapstructure.Decode(resource.Config, config)
  283. if err != nil {
  284. return fmt.Errorf("for resource '%s': error parsing config: %w", resource.Name, err)
  285. }
  286. for _, eg := range config.EnvGroups {
  287. if errStrs := validation.IsDNS1123Label(eg.Name); len(errStrs) > 0 {
  288. str := fmt.Sprintf("for resource '%s': invalid characters found in env group '%s' name:",
  289. resource.Name, eg.Name)
  290. for _, errStr := range errStrs {
  291. str += fmt.Sprintf("\n * %s", errStr)
  292. }
  293. return fmt.Errorf("%s", str)
  294. }
  295. }
  296. return nil
  297. }
  298. func osEnvDriverValidator(resource *types.Resource) error {
  299. return nil
  300. }