idfm-api/types/container_test.go

package types

import (
	"encoding/json"
	"fmt"
	"testing"
)

var containers map[string]*Container

// loadContainers loads the containers in their final form for testing
func loadContainers() error {
	// Get the input
	corpus := testData["container"].correct
	if len(corpus) == 0 {
		return nil
	}

	cs := make(map[string]*Container, len(corpus))
	// For each of them, unmarshal and add to containers
	for name, datum := range corpus {
		c := &Container{}

		err := c.UnmarshalJSON(datum)
		if err != nil {
			return fmt.Errorf("error while unmarshalling: %v", err)
		}

		cs[name] = c
	}

	containers = cs

	return nil
}

// TestContainer_Object_NoCompare tests the Container.Object method
func TestContainer_Object_NoCompare(t *testing.T) {
	// Get the input
	data := containers
	if len(data) == 0 {
		t.Skip("No data to test")
	}

	// Create the run function generator, allowing us to run it in parallel
	rgen := func(c *Container) func(t *testing.T) {
		return func(t *testing.T) {
			// Get the object
			obj, err := c.Object()
			if err != nil {
				t.Errorf("Error while calling .Object(): %v", err)
			}

			// Log it
			t.Logf("Object: %#v", obj)
		}
	}

	// For each of them, let's run a subtest
	for name, datum := range data {
		// Create the run function
		rfunc := rgen(datum)

		// Run !
		t.Run(name, rfunc)
	}
}

// TestContainer_Check_NoCompare tests the Container.Check method
func TestContainer_Check_NoCompare(t *testing.T) {
	// Get the input
	data := containers
	if len(data) == 0 {
		t.Skip("No data to test")
	}

	// Create the run function generator, allowing us to run it in parallel
	rgen := func(c *Container) func(t *testing.T) {
		return func(t *testing.T) {
			err := c.Check()
			if err != nil {
				t.Errorf("Check gave us invalid results: %v", err)
			}
		}
	}

	// For each of them, let's run a subtest
	for name, datum := range data {
		// Create the run function
		rfunc := rgen(datum)

		// Run !
		t.Run(name, rfunc)
	}
}

// BenchmarkContainer_UnmarshalJSON benchmarks Container.UnmarshalJSON through benchmarks
func BenchmarkContainer_UnmarshalJSON(b *testing.B) {
	// Get the bench data
	data := testData["container"].bench
	if len(data) == 0 {
		b.Skip("No data to test")
	}

	// Run function generator, allowing parallel run
	// Returns three functions: one without .Object() being called, one with, one one with only the call to .Object being recorded
	runGen := func(in []byte) (without func(*testing.B), with func(*testing.B), only func(*testing.B)) {
		without = func(b *testing.B) {
			for i := 0; i < b.N; i++ {
				// Unmarshal a Journey
				c := &Container{}
				_ = c.UnmarshalJSON(in)
			}
		}

		with = func(b *testing.B) {
			for i := 0; i < b.N; i++ {
				// Unmarshal a Journey
				c := &Container{}
				_ = c.UnmarshalJSON(in)

				_, _ = c.Object()
			}
		}

		only = func(b *testing.B) {
			for i := 0; i < b.N; i++ {
				// Unmarshal a Journey
				b.StopTimer()
				c := &Container{}
				_ = c.UnmarshalJSON(in)
				b.StartTimer()
				_, _ = c.Object()
			}
		}

		return
	}

	// Loop over all corpus
	for name, datum := range data {
		// Get run function
		without, with, only := runGen(datum)

		// Run it !
		b.Run(name+"_without", without)
		b.Run(name+"_with", with)
		b.Run(name+"_only", only)
	}
}

// BenchmarkContainer_Check benchmarks Container.Check through subbenchmarks
func BenchmarkContainer_Check(b *testing.B) {
	// Get the bench data
	data := testData["container"].bench
	if len(data) == 0 {
		b.Skip("No data to test")
	}

	// Run function generator, allowing parallel run
	runGen := func(in Container) func(*testing.B) {
		return func(b *testing.B) {
			for i := 0; i < b.N; i++ {
				// Call .Check
				_ = in.Check()
			}
		}
	}

	// Loop over all corpus
	for name, datum := range data {
		c := Container{}

		err := json.Unmarshal(datum, &c)
		if err != nil {
			b.Errorf("Error while unmarshalling: %v", err)
		}

		// Get run function
		runFunc := runGen(c)

		// Run it !
		b.Run(name, runFunc)
	}
}

// TestContainer_IsXXX tests (*Container).IsPlace and (*Container).IsPTObject
func TestContainer_IsXXX(t *testing.T) {
	t.Run("IsPlace", func(t *testing.T) {
		for _, et := range embeddedTypesPlace {
			c := &Container{EmbeddedType: et}
			if !c.IsPlace() {
				t.Errorf("IsPlace for embedded type %s: expected true got false", et)
			}
		}
		for _, et := range embeddedTypesPTObject {
			if et != EmbeddedStopArea {
				c := &Container{EmbeddedType: et}
				if c.IsPlace() {
					t.Errorf("IsPlace for embedded type %s: expected false got true", et)
				}
			}
		}
	})

	t.Run("IsPTObject", func(t *testing.T) {
		for _, et := range embeddedTypesPTObject {
			c := &Container{EmbeddedType: et}
			if !c.IsPTObject() {
				t.Errorf("IsPTObject for embedded type %s: expected true got false", et)
			}
		}
		for _, et := range embeddedTypesPlace {
			if et != EmbeddedStopArea {
				c := &Container{EmbeddedType: et}
				if c.IsPTObject() {
					t.Errorf("IsPTObject for embedded type %s: expected false got true", et)
				}
			}
		}
	})
}

// TestContainer_Empty tests that (*Container).Empty reports correctly whether or not the container is truly empty
func TestContainer_Empty(t *testing.T) {
	emptyContainer := Container{}
	nonEmptyContainers := []Container{
		{
			ID: "test",
		},
		{
			Name: "test",
		},
		{
			EmbeddedType: "test",
		},
		{
			Quality: 10,
		},
		{
			embeddedObject: new(Object),
		},
		{
			embeddedJSON: json.RawMessage("that's not very raw"),
		},
	}

	// If the empty container isn't reported as such, error
	if !emptyContainer.Empty() {
		t.Errorf("Calling (*Container).Empty on an empty container returned with false when we expected true")
	}

	// Iterate through the test non-empty containers
	for _, c := range nonEmptyContainers {
		if c.Empty() {
			t.Errorf("Calling (*Container).Empty on a non-empty container returned true when we expected false. Container: %#v", c)
		}
	}
}