driver_validators.go 11 KB

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