From f9c392f50a631a181bc2aa194b9c46504506d657 Mon Sep 17 00:00:00 2001
From: Jhon Honce <jhonce@redhat.com>
Date: Mon, 18 May 2020 18:05:02 -0700
Subject: V2 API Version Support

* Update blang/semver to allow ParseTolerant() support
* Provide helper functions for API handlers to obtain client's 'version'
  path variable focused on API endpoint tree: libpod vs. compat
* Introduce new errors:
  * version not given in path, endpoints may determine if this is a hard
    error (ErrVersionNotGiven)
  * given version not supported (ErrVersionNotSupported), only a soft
    error if the handler is going to hijack the connection
* Added unit tests for version parsing
* bindings check version on connect:
  * client <= Server API version connection is continued
  * client >= Server API version connection fails

Signed-off-by: Jhon Honce <jhonce@redhat.com>
---
 pkg/bindings/bindings.go   |  7 +++++++
 pkg/bindings/connection.go | 17 +++++++++++++++--
 pkg/bindings/version.go    |  3 ---
 3 files changed, 22 insertions(+), 5 deletions(-)
 delete mode 100644 pkg/bindings/version.go

(limited to 'pkg/bindings')

diff --git a/pkg/bindings/bindings.go b/pkg/bindings/bindings.go
index 5e2882aae..7e2a444bd 100644
--- a/pkg/bindings/bindings.go
+++ b/pkg/bindings/bindings.go
@@ -8,6 +8,10 @@
 
 package bindings
 
+import (
+	"github.com/blang/semver"
+)
+
 var (
 	// PTrue is a convenience variable that can be used in bindings where
 	// a pointer to a bool (optional parameter) is required.
@@ -17,4 +21,7 @@ var (
 	// a pointer to a bool (optional parameter) is required.
 	pFalse = false
 	PFalse = &pFalse
+
+	// _*YES*- podman will fail to run if this value is wrong
+	APIVersion = semver.MustParse("1.0.0")
 )
diff --git a/pkg/bindings/connection.go b/pkg/bindings/connection.go
index d83c0482c..d21d55beb 100644
--- a/pkg/bindings/connection.go
+++ b/pkg/bindings/connection.go
@@ -15,6 +15,7 @@ import (
 	"strings"
 	"time"
 
+	"github.com/blang/semver"
 	"github.com/containers/libpod/pkg/api/types"
 	jsoniter "github.com/json-iterator/go"
 	"github.com/pkg/errors"
@@ -143,7 +144,7 @@ func tcpClient(_url *url.URL) (Connection, error) {
 }
 
 // pingNewConnection pings to make sure the RESTFUL service is up
-// and running. it should only be used where initializing a connection
+// and running. it should only be used when initializing a connection
 func pingNewConnection(ctx context.Context) error {
 	client, err := GetClient(ctx)
 	if err != nil {
@@ -154,8 +155,20 @@ func pingNewConnection(ctx context.Context) error {
 	if err != nil {
 		return err
 	}
+
 	if response.StatusCode == http.StatusOK {
-		return nil
+		v, err := semver.ParseTolerant(response.Header.Get("Libpod-API-Version"))
+		if err != nil {
+			return err
+		}
+
+		switch APIVersion.Compare(v) {
+		case 1, 0:
+			// Server's job when client version is equal or older
+			return nil
+		case -1:
+			return errors.Errorf("server API version is too old. client %q server %q", APIVersion.String(), v.String())
+		}
 	}
 	return errors.Errorf("ping response was %q", response.StatusCode)
 }
diff --git a/pkg/bindings/version.go b/pkg/bindings/version.go
deleted file mode 100644
index c833a644c..000000000
--- a/pkg/bindings/version.go
+++ /dev/null
@@ -1,3 +0,0 @@
-package bindings
-
-func (c Connection) Version() {}
-- 
cgit v1.2.3-54-g00ecf