Merge pull request #139 from section/add-script-deploy-protection

improved prevalidation

Author: AskAlice

commands/deploy.go

@@ -61,7 +61,7 @@ func (c *DeployCmd) Run(ctx *kong.Context, logWriters *LogWriters) (err error) {
 		}
 	}
 
-	log.Info().Msg(Green("Deploying your node.js package to Account ID: %d, App ID: %d, Environment %s",c.AccountID, c.AppID, c.Environment))
+	log.Info().Msg(Green("Deploying your node.js package to Account ID: %d, App ID: %d, Environment %s", c.AccountID, c.AppID, c.Environment))
 	if !c.SkipValidation {
 		errs := IsValidNodeApp(dir)
 		if len(errs) > 0 {
@@ -86,7 +86,7 @@ func (c *DeployCmd) Run(ctx *kong.Context, logWriters *LogWriters) (err error) {
 	s.Stop()
 	log.Debug().Msg("Archiving files:")
 	for _, file := range files {
-		log.Debug().Str("file",file)
+		log.Debug().Str("file", file)
 	}
 
 	tempFile, err := ioutil.TempFile("", "sectionctl-deploy.*.tar.gz")
@@ -130,11 +130,11 @@ func (c *DeployCmd) Run(ctx *kong.Context, logWriters *LogWriters) (err error) {
 
 	req.Header.Add("section-token", api.Token)
 
-	log.Debug().Str("URL",req.URL.String())
+	log.Debug().Str("URL", req.URL.String())
 
 	artifactSizeMB := stat.Size() / 1024 / 1024
 	log.Debug().Msg(fmt.Sprintf("Upload artifact is %dMB (%d bytes) large", artifactSizeMB, stat.Size()))
-	s = NewSpinner(fmt.Sprintf("Uploading app (%dMB)...", artifactSizeMB),logWriters)
+	s = NewSpinner(fmt.Sprintf("Uploading app (%dMB)...", artifactSizeMB), logWriters)
 	s.Start()
 	client := &http.Client{
 		Timeout: c.Timeout,
@@ -171,9 +171,24 @@ func (c *DeployCmd) Run(ctx *kong.Context, logWriters *LogWriters) (err error) {
 // IsValidNodeApp detects if a Node.js app is present in a given directory
 func IsValidNodeApp(dir string) (errs []error) {
 	packageJSONPath := filepath.Join(dir, "package.json")
-	if _, err := os.Stat(packageJSONPath); os.IsNotExist(err) {
-		errs = append(errs, fmt.Errorf("%s is not a file", packageJSONPath))
+	if packageJSONContents, err := ioutil.ReadFile(packageJSONPath); err != nil {
+		if os.IsNotExist(err) {
+			log.Debug().Msg(fmt.Sprintf("[WARN] %s is not a file", packageJSONPath))
+		} else {
+			log.Info().Err(err).Msg("Error reading your package.json")
+		}		
+	} else {
+		packageJSON, err := ParsePackageJSON(string(packageJSONContents))
+		if err != nil {
+			log.Info().Err(err).Msg("Error parsing your package.json")
+		}
+		if len(packageJSON.Section.StartScript) == 0 && packageJSON.Scripts["start"] == "" {
+			errs = append(errs, fmt.Errorf("package.json does not include a start script. please add one"))
+		} else if len(packageJSON.Section.StartScript) > 0 && len(packageJSON.Scripts[packageJSON.Section.StartScript]) == 0 {
+			errs = append(errs, fmt.Errorf("package.json does not include the script: %s", packageJSON.Section.StartScript))
+		}
 	}
+
 	nodeModulesPath := filepath.Join(dir, "node_modules")
 	fi, err := os.Stat(nodeModulesPath)
 	if os.IsNotExist(err) {

commands/testdata/deploy/valid-nodejs-app/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "example",
+  "version": "1.0.0",
+  "description": "This is just an example package for the go tests.",
+  "main": "index.js",
+  "scripts": {
+    "predeploy": "npm install",
+    "deploy": "sectionctl deploy",
+    "start": "npx serve node_modules -l 8080"
+  },
+  "author": "section.io",
+  "license": "ISC"
+}