Added in high document API

filling out documentation, looking at DX and how to consume things, re-shuffling and cleaning house.

datamodel/spec_info_test.go

@@ -4,15 +4,228 @@
 package datamodel
 
 import (
-    "github.com/stretchr/testify/assert"
-    "testing"
+	"github.com/pb33f/libopenapi/utils"
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+const (
+	// OpenApi3 is used by all OpenAPI 3+ docs
+	OpenApi3 = "openapi"
+
+	// OpenApi2 is used by all OpenAPI 2 docs, formerly known as swagger.
+	OpenApi2 = "swagger"
+
+	// AsyncApi is used by akk AsyncAPI docs, all versions.
+	AsyncApi = "asyncapi"
 )
 
 func TestSpecInfo_GetJSONParsingChannel(t *testing.T) {
 
-    // dumb, but we need to ensure coverage is as high as we can make it.
-    bchan := make(chan bool)
-    si := &SpecInfo{JsonParsingChannel: bchan}
-    assert.Equal(t, si.GetJSONParsingChannel(), bchan)
+	// dumb, but we need to ensure coverage is as high as we can make it.
+	bchan := make(chan bool)
+	si := &SpecInfo{JsonParsingChannel: bchan}
+	assert.Equal(t, si.GetJSONParsingChannel(), bchan)
 
 }
+
+var goodJSON = `{"name":"kitty", "noises":["meow","purrrr","gggrrraaaaaooooww"]}`
+var badJSON = `{"name":"kitty, "noises":[{"meow","purrrr","gggrrraaaaaooooww"]}}`
+var goodYAML = `name: kitty
+noises:
+- meow
+- purrr
+- gggggrrraaaaaaaaaooooooowwwwwww
+`
+
+var badYAML = `name: kitty
+  noises:
+   - meow
+    - purrr
+    - gggggrrraaaaaaaaaooooooowwwwwww
+`
+
+var OpenApiWat = `openapi: 3.2
+info:
+  title: Test API, valid, but not quite valid 
+servers:
+  - url: https://quobix.com/api`
+
+var OpenApiFalse = `openapi: false
+info:
+  title: Test API version is a bool?
+servers:
+  - url: https://quobix.com/api`
+
+var OpenApiOne = `openapi: 1.0.1
+info:
+  title: Test API version is what version?
+servers:
+  - url: https://quobix.com/api`
+
+var OpenApi3Spec = `openapi: 3.0.1
+info:
+  title: Test API
+tags:
+  - name: "Test"
+  - name: "Test 2"
+servers:
+  - url: https://quobix.com/api`
+
+var OpenApi2Spec = `swagger: 2.0.1
+info:
+  title: Test API
+tags:
+  - name: "Test"
+servers:
+  - url: https://quobix.com/api`
+
+var OpenApi2SpecOdd = `swagger: 3.0.1
+info:
+  title: Test API
+tags:
+  - name: "Test"
+servers:
+  - url: https://quobix.com/api`
+
+var AsyncAPISpec = `asyncapi: 2.0.0
+info:
+  title: Hello world application
+  version: '0.1.0'
+channels:
+  hello:
+    publish:
+      message:
+        payload:
+          type: string
+          pattern: '^hello .+$'`
+
+var AsyncAPISpecOdd = `asyncapi: 3.0.0
+info:
+  title: Hello world application
+  version: '0.1.0'`
+
+func TestExtractSpecInfo_ValidJSON(t *testing.T) {
+	r, e := ExtractSpecInfo([]byte(goodJSON))
+	<-r.JsonParsingChannel
+	assert.Greater(t, len(*r.SpecJSONBytes), 0)
+	assert.Error(t, e)
+}
+
+func TestExtractSpecInfo_InvalidJSON(t *testing.T) {
+	_, e := ExtractSpecInfo([]byte(badJSON))
+	assert.Error(t, e)
+}
+
+func TestExtractSpecInfo_Nothing(t *testing.T) {
+	_, e := ExtractSpecInfo([]byte(""))
+	assert.Error(t, e)
+}
+
+func TestExtractSpecInfo_ValidYAML(t *testing.T) {
+	r, e := ExtractSpecInfo([]byte(goodYAML))
+	<-r.JsonParsingChannel
+	assert.Greater(t, len(*r.SpecJSONBytes), 0)
+	assert.Error(t, e)
+}
+
+func TestExtractSpecInfo_InvalidYAML(t *testing.T) {
+	_, e := ExtractSpecInfo([]byte(badYAML))
+	assert.Error(t, e)
+}
+
+func TestExtractSpecInfo_InvalidOpenAPIVersion(t *testing.T) {
+	_, e := ExtractSpecInfo([]byte(OpenApiOne))
+	assert.Error(t, e)
+}
+
+func TestExtractSpecInfo_OpenAPI3(t *testing.T) {
+
+	r, e := ExtractSpecInfo([]byte(OpenApi3Spec))
+	assert.Nil(t, e)
+	assert.Equal(t, utils.OpenApi3, r.SpecType)
+	assert.Equal(t, "3.0.1", r.Version)
+
+	<-r.JsonParsingChannel
+	assert.Greater(t, len(*r.SpecJSONBytes), 0)
+
+}
+
+func TestExtractSpecInfo_OpenAPIWat(t *testing.T) {
+
+	r, e := ExtractSpecInfo([]byte(OpenApiWat))
+	assert.Nil(t, e)
+	assert.Equal(t, OpenApi3, r.SpecType)
+	assert.Equal(t, "3.2", r.Version)
+}
+
+func TestExtractSpecInfo_OpenAPIFalse(t *testing.T) {
+
+	spec, e := ExtractSpecInfo([]byte(OpenApiFalse))
+	assert.NoError(t, e)
+	assert.Equal(t, "false", spec.Version)
+}
+
+func TestExtractSpecInfo_OpenAPI2(t *testing.T) {
+
+	r, e := ExtractSpecInfo([]byte(OpenApi2Spec))
+	assert.Nil(t, e)
+	assert.Equal(t, OpenApi2, r.SpecType)
+	assert.Equal(t, "2.0.1", r.Version)
+
+	<-r.JsonParsingChannel
+	assert.Greater(t, len(*r.SpecJSONBytes), 0)
+}
+
+func TestExtractSpecInfo_OpenAPI2_OddVersion(t *testing.T) {
+
+	_, e := ExtractSpecInfo([]byte(OpenApi2SpecOdd))
+	assert.NotNil(t, e)
+	assert.Equal(t,
+		"spec is defined as a swagger (openapi 2.0) spec, but is an openapi 3 or unknown version", e.Error())
+}
+
+func TestExtractSpecInfo_AsyncAPI(t *testing.T) {
+
+	r, e := ExtractSpecInfo([]byte(AsyncAPISpec))
+	assert.Nil(t, e)
+	assert.Equal(t, AsyncApi, r.SpecType)
+	assert.Equal(t, "2.0.0", r.Version)
+	<-r.JsonParsingChannel
+	assert.Greater(t, len(*r.SpecJSONBytes), 0)
+}
+
+func TestExtractSpecInfo_AsyncAPI_OddVersion(t *testing.T) {
+
+	_, e := ExtractSpecInfo([]byte(AsyncAPISpecOdd))
+	assert.NotNil(t, e)
+	assert.Equal(t,
+		"spec is defined as asyncapi, but has a major version that is invalid", e.Error())
+}
+
+func TestExtractSpecInfo_BadVersion_OpenAPI3(t *testing.T) {
+
+	yml := `openapi:
+ should: fail`
+
+	_, err := ExtractSpecInfo([]byte(yml))
+	assert.Error(t, err)
+}
+
+func TestExtractSpecInfo_BadVersion_Swagger(t *testing.T) {
+
+	yml := `swagger:
+ should: fail`
+
+	_, err := ExtractSpecInfo([]byte(yml))
+	assert.Error(t, err)
+}
+
+func TestExtractSpecInfo_BadVersion_AsyncAPI(t *testing.T) {
+
+	yml := `asyncapi:
+ should: fail`
+
+	_, err := ExtractSpecInfo([]byte(yml))
+	assert.Error(t, err)
+}