Merge pull request #377 from tianon/deprecation

Deprecate boot2docker-cli officially

Author: tianon

README.md

@@ -1,10 +1,10 @@
-# Pending Deprecation
+# Deprecated
 
-This project is officially in bug fixing/maintenance mode in favor of all
-concerted effort going towards [Docker
-Machine](https://github.com/docker/machine) instead.  Merging of complex
-features will require some pretty strong convincing as to why they should exist
-here, and not instead be proposed for Docker Machine.
+This project is officially deprecated in favor of [Docker
+Machine](https://docs.docker.com/machine/).  The code and documentation here
+only exist as a reference for users who have not yet switched over (but please
+do soon).  The recommended way to install Machine is with the [Docker
+Toolbox](https://docker.com/toolbox).
 
 # boot2docker command line management tool
 

cmds.go

@@ -4,7 +4,6 @@ import (
 	"encoding/json"
 	"fmt"
 	"io/ioutil"
-	"net/http"
 	"os"
 	"os/exec"
 	"path/filepath"
@@ -357,16 +356,6 @@ func cmdPoweroff() error {
 
 // Upgrade the boot2docker ISO - preserving server state
 func cmdUpgrade() error {
-	if runtime.GOOS == "darwin" || runtime.GOOS == "linux" {
-		if B2D.Clobber {
-			err := upgradeDockerClientBinary()
-			if err != nil {
-				return err
-			}
-		} else {
-			fmt.Println("Skipping client binary download, use --clobber=true to enable...")
-		}
-	}
 	if err := upgradeBoot2DockerBinary(); err != nil {
 		return fmt.Errorf("Error upgrading boot2docker binary: %s", err)
 	}
@@ -422,46 +411,6 @@ func upgradeBoot2DockerBinary() error {
 	return nil
 }
 
-func upgradeDockerClientBinary() error {
-	var (
-		clientOs, clientArch string
-	)
-	resp, err := http.Get("https://get.docker.com/latest")
-	if err != nil {
-		return fmt.Errorf("Error checking the latest version of Docker: %s", err)
-	}
-	defer resp.Body.Close()
-	latestVersionBytes, err := ioutil.ReadAll(resp.Body)
-	if err != nil {
-		return fmt.Errorf("Error reading response body on latest version of Docker call: %s", err)
-	}
-	latestVersion := strings.TrimSpace(string(latestVersionBytes))
-	localClientVersion, err := getLocalClientVersion()
-	if err != nil {
-		return fmt.Errorf("Error getting local Docker client version: %s", err)
-	}
-	switch runtime.GOARCH {
-	case "amd64":
-		clientArch = "x86_64"
-	default:
-		return fmt.Errorf("Architecture not supported")
-	}
-
-	switch runtime.GOOS {
-	case "darwin":
-		clientOs = "Darwin"
-	case "linux":
-		clientOs = "Linux"
-	default:
-		return fmt.Errorf("Operating system not supported")
-	}
-	binaryUrl := fmt.Sprintf("https://get.docker.com/builds/%s/%s/docker-latest", clientOs, clientArch)
-	if err := attemptUpgrade(binaryUrl, "docker", latestVersion, localClientVersion); err != nil {
-		return fmt.Errorf("Error attempting upgrade: %s", err)
-	}
-	return nil
-}
-
 func attemptUpgrade(binaryUrl, binaryName, latestVersion, localVersion string) error {
 	if (latestVersion != localVersion && !strings.Contains(latestVersion, "rc")) || B2D.ForceUpgradeDownload {
 		if err := backupAndDownload(binaryUrl, binaryName, localVersion); err != nil {

main.go

@@ -2,6 +2,8 @@ package main
 
 import (
 	"fmt"
+	"io/ioutil"
+	"net/http"
 	"os"
 )
 
@@ -11,6 +13,16 @@ var (
 	GitSHA  string
 )
 
+const (
+	hardcodedWarning = `
+        WARNING: The 'boot2docker' command line interface is being officially deprecated.
+	Users are expected to switch to Docker Machine (https://docs.docker.com/machine/) instead ASAP.
+	The Docker Toolbox is the recommended way to install it: https://docker.com/toolbox/
+
+`
+	warningURL = "https://raw.githubusercontent.com/boot2docker/boot2docker-cli/master/DEPRECATION_WARNING"
+)
+
 type unknownCommandError struct {
 	cmd string
 }
@@ -48,8 +60,10 @@ func run() error {
 	case "config", "cfg":
 		return cmdConfig()
 	case "init":
+		printDeprecationWarning()
 		return cmdInit()
 	case "up", "start", "boot", "resume":
+		printDeprecationWarning()
 		return cmdUp()
 	case "save", "suspend":
 		return cmdSave()
@@ -88,3 +102,27 @@ func run() error {
 		return unknownCommandError{cmd: cmd}
 	}
 }
+
+func printDeprecationWarning() {
+	var (
+		warning string
+	)
+
+	// Try to get the warning from the Github raw URL.  If there's any
+	// failure along the way, e.g. network, just fall back to the default
+	// warning hardcoded in the source.
+	resp, err := http.Get(warningURL)
+	if err != nil || resp.StatusCode != http.StatusOK {
+		warning = hardcodedWarning
+	} else {
+		defer resp.Body.Close()
+		body, err := ioutil.ReadAll(resp.Body)
+		if err != nil {
+			warning = hardcodedWarning
+		} else {
+			warning = string(body)
+		}
+	}
+
+	fmt.Fprintln(os.Stderr, warning)
+}

util.go

@@ -110,8 +110,12 @@ func getLatestReleaseName(url string) (string, error) {
 	defer rsp.Body.Close()
 
 	var t []struct {
-		Name    string `json:"name"`
-		TagName string `json:"tag_name"`
+		// ".../tags" endpoints
+		Name string `json:"name"`
+
+		// ".../releases" endpoints
+		TagName    string `json:"tag_name"`
+		Prerelease bool   `json:"prerelease"`
 	}
 	body, err := ioutil.ReadAll(rsp.Body)
 	if err != nil {
@@ -129,19 +133,25 @@ func getLatestReleaseName(url string) (string, error) {
 		return "", fmt.Errorf("Error getting releases: %s\n see %s", e.Message, e.DocumentationUrl)
 	}
 	if len(t) == 0 {
-		return "", fmt.Errorf("no releases found")
+		return "", fmt.Errorf("no releases found at %q", url)
 	}
 
 	// Looking up by tag instead of release.
 	// Github API call for docker releases yields nothing,
 	// so we use tags API call in this case.
-	name := ""
 	if strings.Contains(url, "tags") {
-		name = t[0].Name
-	} else {
-		name = t[0].TagName
+		return t[0].Name, nil
+	}
+
+	for _, rel := range t {
+		if rel.Prerelease {
+			// skip "pre-releases" (RCs, etc) entirely
+			continue
+		}
+		return rel.TagName, nil
 	}
-	return name, nil
+
+	return "", fmt.Errorf("no non-prerelease releases found at %q", url)
 }
 
 func getLocalClientVersion() (string, error) {