Handle errors when couldn't download config or docker-compose

Signed-off-by: David Pordomingo <[email protected]>

Author: dpordomingo

cmd/sourced/cmd/compose.go

@@ -27,7 +27,7 @@ func (c *composeDownloadCmd) Execute(args []string) error {
 		v = version
 	}
 
-	err := composefile.Download(v)
+	err := composefile.ActivateFromRemote(v)
 	if err != nil {
 		return err
 	}

cmd/sourced/cmd/root.go

@@ -5,6 +5,8 @@ import (
 	"os"
 	"runtime"
 
+	"github.com/src-d/sourced-ce/cmd/sourced/compose"
+	"github.com/src-d/sourced-ce/cmd/sourced/compose/file"
 	"github.com/src-d/sourced-ce/cmd/sourced/compose/workdir"
 	"github.com/src-d/sourced-ce/cmd/sourced/dir"
 	"github.com/src-d/sourced-ce/cmd/sourced/format"
@@ -65,11 +67,29 @@ func log(err error) {
 		printRed("Cannot perform this action, full re-initialization is needed, run 'prune' command first")
 	case dir.ErrNotValid.Is(err):
 		printRed("Cannot perform this action, config directory is not valid")
+	case compose.ErrComposeAlternative.Is(err):
+		printRed("docker-compose is not installed, and there was an error while trying to use the container alternative")
+		printRed("  see: https://docs.sourced.tech/community-edition/quickstart/1-install-requirements#docker-compose")
+	case file.ErrConfigDownload.Is(err):
+		printRed("The source{d} CE config file could not be set as active")
 	case fmt.Sprintf("%T", err) == "*flags.Error":
 		// syntax error is already logged by go-cli
 	default:
 		// unknown errors have no special message
 	}
+
+	switch {
+	case dir.ErrNetwork.Is(err):
+		// TODO(dpordomingo): if start using "https://golang.org/pkg/errors/",
+		//					  we could do `var myErr ErrNetwork; errors.As(err, &myErr)`
+		// 					  to provide more info about the actual network error
+		printRed("The resource could not be downloaded from the Internet")
+		printRed("  see: https://docs.sourced.tech/community-edition/quickstart/1-install-requirements#internet-connection")
+	case dir.ErrWrite.Is(err):
+		// TODO(dpordomingo): see todo above
+		printRed("could not write file")
+
+	}
 }
 
 func printRed(message string) {

cmd/sourced/compose/compose.go

@@ -14,6 +14,7 @@ import (
 	"github.com/src-d/sourced-ce/cmd/sourced/dir"
 
 	"github.com/pkg/errors"
+	goerrors "gopkg.in/src-d/go-errors.v1"
 )
 
 // dockerComposeVersion is the version of docker-compose to download
@@ -22,6 +23,9 @@ const dockerComposeVersion = "1.24.0"
 
 var composeContainerURL = fmt.Sprintf("https://github.com/docker/compose/releases/download/%s/run.sh", dockerComposeVersion)
 
+// ErrComposeAlternative is returned when docker-compose alternative could not be installed
+var ErrComposeAlternative = goerrors.NewKind("error while trying docker-compose container alternative")
+
 type Compose struct {
 	bin            string
 	workdirHandler *workdir.Handler
@@ -81,13 +85,13 @@ func getOrInstallComposeBinary() (string, error) {
 
 	path, err = getOrInstallComposeContainer()
 	if err != nil {
-		return "", errors.Wrapf(err, "error while getting docker-compose container")
+		return "", ErrComposeAlternative.Wrap(err)
 	}
 
 	return path, nil
 }
 
-func getOrInstallComposeContainer() (string, error) {
+func getOrInstallComposeContainer() (altPath string, err error) {
 	datadir, err := dir.Path()
 	if err != nil {
 		return "", err
@@ -96,19 +100,20 @@ func getOrInstallComposeContainer() (string, error) {
 	dirPath := filepath.Join(datadir, "bin")
 	path := filepath.Join(dirPath, fmt.Sprintf("docker-compose-%s.sh", dockerComposeVersion))
 
-	if _, err := os.Stat(path); err == nil {
+	readExecAccessMode := os.FileMode(0500)
+
+	if info, err := os.Stat(path); err == nil {
+		if info.Mode()&readExecAccessMode != readExecAccessMode {
+			return "", fmt.Errorf("%s can not be run", path)
+		}
+
 		return path, nil
 	} else if !os.IsNotExist(err) {
 		return "", err
 	}
 
-	err = os.MkdirAll(dirPath, os.ModePerm)
-	if err != nil {
-		return "", errors.Wrapf(err, "error while creating directory %s", dirPath)
-	}
-
 	if err := downloadCompose(path); err != nil {
-		return "", errors.Wrapf(err, "error downloading %s", composeContainerURL)
+		return "", err
 	}
 
 	cmd := exec.CommandContext(context.Background(), "chmod", "+x", path)

cmd/sourced/compose/file/file.go

@@ -13,8 +13,15 @@ import (
 	datadir "github.com/src-d/sourced-ce/cmd/sourced/dir"
 
 	"github.com/pkg/errors"
+	goerrors "gopkg.in/src-d/go-errors.v1"
 )
 
+// ErrConfigDownload is returned when docker-compose.yml could not be downloaded
+var ErrConfigDownload = goerrors.NewKind("docker-compose.yml config file could not be downloaded")
+
+// ErrConfigActivation is returned when docker-compose.yml could not be set as active
+var ErrConfigActivation = goerrors.NewKind("docker-compose.yml could not be set as active")
+
 const (
 	orgName         = "src-d"
 	repoName        = "sourced-ce"
@@ -61,7 +68,7 @@ func InitDefault() (string, error) {
 		return "", err
 	}
 
-	err = Download(version)
+	err = ActivateFromRemote(version)
 	if err != nil {
 		return "", err
 	}
@@ -96,9 +103,9 @@ func InitDefaultOverride() (string, error) {
 	return globalOverridePath, nil
 }
 
-// Download downloads the docker-compose.yml file from the given revision
-// or URL. The file is set as the active compose file.
-func Download(revOrURL RevOrURL) error {
+// ActivateFromRemote downloads the docker-compose.yml file from the given revision
+// or URL, and sets it as the active compose file.
+func ActivateFromRemote(revOrURL RevOrURL) (err error) {
 	var url string
 	if isURL(revOrURL) {
 		url = revOrURL
@@ -113,10 +120,15 @@ func Download(revOrURL RevOrURL) error {
 
 	err = datadir.DownloadURL(url, outPath)
 	if err != nil {
-		return err
+		return ErrConfigDownload.Wrap(err)
+	}
+
+	err = SetActive(revOrURL)
+	if err != nil {
+		return ErrConfigActivation.Wrap(err)
 	}
 
-	return SetActive(revOrURL)
+	return nil
 }
 
 // SetActive makes a symlink from

cmd/sourced/dir/dir.go

@@ -18,6 +18,12 @@ var ErrNotExist = goerrors.NewKind("%s does not exist")
 // ErrNotValid is returned when config dir is not valid
 var ErrNotValid = goerrors.NewKind("%s is not a valid config directory: %s")
 
+// ErrNetwork is returned when could not download
+var ErrNetwork = goerrors.NewKind("network error downloading %s")
+
+// ErrWrite is returned when could not write
+var ErrWrite = goerrors.NewKind("write error at %s")
+
 // Path returns the absolute path for $SOURCED_DIR, or $HOME/.sourced if unset
 // and returns an error if it does not exist or it could not be read.
 func Path() (string, error) {
@@ -96,29 +102,33 @@ func validate(path string) error {
 
 // DownloadURL downloads the given url to a file to the
 // dst path, creating the directory if it's needed
-func DownloadURL(url, dst string) error {
+func DownloadURL(url, dst string) (err error) {
 	resp, err := http.Get(url)
 	if err != nil {
-		return err
+		return ErrNetwork.Wrap(err, url)
 	}
 	defer resp.Body.Close()
 
 	if resp.StatusCode != http.StatusOK {
-		return fmt.Errorf("HTTP status %v", resp.Status)
+		return ErrNetwork.Wrap(fmt.Errorf("HTTP status %v", resp.Status), url)
 	}
 
 	if err := os.MkdirAll(filepath.Dir(dst), os.ModePerm); err != nil {
-		return err
+		return ErrWrite.Wrap(err, filepath.Dir(dst))
 	}
 
 	out, err := os.Create(dst)
 	if err != nil {
-		return err
+		return ErrWrite.Wrap(err, dst)
 	}
 	defer out.Close()
 
 	_, err = io.Copy(out, resp.Body)
-	return err
+	if err != nil {
+		return ErrWrite.Wrap(err, dst)
+	}
+
+	return nil
 }
 
 // TmpPath returns the absolute path for /tmp/srcd

cmd/sourced/dir/dir_test.go

@@ -1,13 +1,15 @@
 package dir
 
 import (
+	"fmt"
 	"io/ioutil"
 	"net/http"
 	"net/http/httptest"
 	"os"
 	"path"
 	"testing"
 
+	"github.com/pkg/errors"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -114,5 +116,10 @@ func TestDownloadURL(t *testing.T) {
 	}
 	server = httptest.NewServer(http.HandlerFunc(handler))
 	err = DownloadURL(server.URL, "/dev/null")
-	assert.EqualError(err, "HTTP status 404 Not Found")
+	errExpected := errors.Wrapf(
+		fmt.Errorf("HTTP status %v", "404 Not Found"),
+		"network error downloading %s", server.URL,
+	)
+
+	assert.EqualError(err, errExpected.Error())
 }

docs/learn-more/faq.md

@@ -10,6 +10,8 @@ _For tips and advices to deal with unexpected errors, please refer to [Troublesh
 - [Can I Query Gitbase or Babelfish with External Tools?](#can-i-query-gitbase-or-babelfish-with-external-tools)
 - [Where Can I Read More About the Web Interface?](#where-can-i-read-more-about-the-web-interface)
 - [I Get IOError Permission denied](#i-get-ioerror-permission-denied)
+- [Why Do I Need Internet Connection?](#why-do-i-need-internet-connection)
+
 
 ## Where Can I Find More Assistance to Run source{d} or Notify You About Any Issue or Suggestion?
 
@@ -118,6 +120,7 @@ The user interface is based in the open-sourced [Apache Superset](http://superse
 so you can also refer to [Superset tutorials](http://superset.apache.org/tutorial.html)
 for advanced usage of the web interface.
 
+
 ## I Get IOError Permission denied
 
 If you get this error message:
@@ -127,3 +130,15 @@ IOError: [Errno 13] Permission denied: u'./.env'
 ```
 
 This may happen if you have installed Docker from a snap package. This installation mode is not supported, please install it following [the official documentation](./quickstart/1-install-requirements.md#install-docker) (See [#78](https://github.com/src-d/sourced-ce/issues/78)).
+
+
+## Why Do I Need Internet Connection?
+
+source{d} CE automatically fetches some resources from the Internet when they are not found locally:
+
+- the source{d} CE configuration is fetched automatically when initializing it for the first time, using the proper version for the current version of `sourced`, e.g. if using `v0.16.0` it will automatically fetch `https://raw.githubusercontent.com/src-d/sourced-ce/v0.16.0/docker-compose.yml`.
+- to download the docker images of the source{d} CE components when initializing source{d} for the first time, or when initializing it after changing its configuration.
+- to download repositories and its metadata from GitHub when you initialize source{d} CE with `sourced init orgs`.
+- to download and install [Docker Compose alternative](#docker-compose) if there is no local installation of Docker Compose.
+
+If your connection to the network does not let source{d} CE to access to Internet, you should manually provide all these dependencies.

docs/quickstart/1-install-requirements.md

@@ -15,6 +15,12 @@ Follow the instructions based on your OS:
 
 ## Docker Compose
 
-**source{d} CE** is deployed as Docker containers, using [Docker Compose](https://docs.docker.com/compose), but it is not required to have a local installation of Docker Compose; if it is not found it will be deployed inside a container.
+**source{d} CE** is deployed as Docker containers, using [Docker Compose](https://docs.docker.com/compose), but it is not required to have a local installation of Docker Compose; if it is not found it will be downloaded from docker sources, and deployed inside a container.
 
-If you prefer a local installation of Docker Compose, you can follow the [Docker Compose install guide](https://docs.docker.com/compose/install)
+If you prefer a local installation of Docker Compose, or you have no access to internet to download it, you can follow the [Docker Compose install guide](https://docs.docker.com/compose/install)
+
+## Internet Connection
+
+source{d} CE automatically fetches some resources from the Internet when they are not found locally, so in order to use all source{d} CE capacities, Internet connection is needed.
+
+For more details, you can refer to [Why Do I Need Internet Connection?](../learn-more/faq.md#why-do-i-need-internet-connection)