raml_test.go

// Copyright 2014 DoAT. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
//    this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation and/or
//    other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED “AS IS” WITHOUT ANY WARRANTIES WHATSOEVER.
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
// THE IMPLIED WARRANTIES OF NON INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A
// PARTICULAR PURPOSE ARE HEREBY DISCLAIMED. IN NO EVENT SHALL DoAT OR CONTRIBUTORS
// BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// The views and conclusions contained in the software and documentation are those of
// the authors and should not be interpreted as representing official policies,
// either expressed or implied, of DoAT.

package raml

// This file contains tests.

import (
	"fmt"
	"testing"
)

// TODO: Way, way more serious tests.
//
// Inspirations:
// 	 	https://github.com/raml-org/raml-js-parser/tree/master/test
//		https://github.com/raml-org/raml-java-parser/tree/master/src/test
// 		https://github.com/an2deg/pyraml-parser/tree/master/tests
//		https://github.com/cybertk/ramlev/tree/master/test/fixtures

func TestFailedParsing(t *testing.T) {

	fileNames := []string{"./samples/bad_raml.raml"}

	for _, fileName := range fileNames {

		fmt.Printf("Attempting to parse RAML file: %s\n", fileName)

		_, err := ParseFile(fileName)

		if err == nil {
			t.Fatalf("Failed detecting bad RAML file %s", fileName)
		} else {
			fmt.Printf("Detected bad RAML file %s:\n%s", fileName, err.Error())
		}
	}
}

func TestParsing(t *testing.T) {

	fileNames := []string{"./samples/example.raml",
		"./samples/simple_example.raml",
		"./samples/other_example.raml",
		"./samples/congo/api.raml",
		"./samples/notes/api.raml",
		"./samples/github/github-api-v3.raml",
		"./samples/raml-tutorial-200/jukebox-api.raml"}

	for _, fileName := range fileNames {

		fmt.Printf("Attempting to parse RAML file: %s\n", fileName)

		apiDefinition, err := ParseFile(fileName)

		if err != nil {
			t.Fatalf("Failed parsing file %s:\n  %s", fileName, err.Error())
		} else {
			fmt.Printf("Successfully parsed file %s!\n", fileName)
		}

		if apiDefinition.RAMLVersion != "#%RAML 0.8" {
			t.Fatalf("Detected erroneous RAML version: %s",
				apiDefinition.RAMLVersion)
		}

		// 	pretty.Println(apiDefinition)
	}
}

func TestMethodStringer(t *testing.T) {
	def, _ := ParseFile("./samples/simple_example.raml")
	r := def.Resources["/resources"]
	if r.Get.Name != "GET" {
		t.Errorf("Got %s, instead of GET", r.Get.Name)
	}
	n := r.Nested["/{resourceId}"]
	if n.Get.Name != "GET" {
		t.Errorf("Got %s, instead of GET", n.Get.Name)
	}
	if n.Put.Name != "PUT" {
		t.Errorf("Got %s, instead of PUT", n.Put.Name)
	}
	if n.Delete.Name != "DELETE" {
		t.Errorf("Got %s, instead of DELETE", n.Delete.Name)
	}
}