outputs.go

/*
Copyright 2019 Cloudical Deutschland GmbH. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
    http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package outputs

import (
	"bytes"
	"html/template"

	"github.com/galexrt/ancientt/pkg/config"
	"go.uber.org/zap"
)

// Factories contains the list of all available outputs.
// The outputs can each then be created using the function saved in the map.
var Factories = make(map[string]func(logger *zap.Logger, cfg *config.Config, outCfg *config.Output) (Output, error))

// Output is the interface a output has to implement.
type Output interface {
	// Do do output related work on the given Data
	Do(data Data) error
	// OutputFiles return a list of output files
	OutputFiles() []string
	// Close run "cleanup" / close tasks, e.g., close file handles and others
	Close() error
}

// GetFilenameFromPattern get filename from given pattern, data and extra data for templating.
func GetFilenameFromPattern(pattern string, role string, data Data, extra map[string]interface{}) (string, error) {
	t, err := template.New("main").Parse(pattern)
	if err != nil {
		return "", err
	}

	variables := struct {
		Role          string
		Data          Data
		TestStartTime int64
		TestTime      int64
		Extra         map[string]interface{}
	}{
		Role:          role,
		Data:          data,
		TestStartTime: data.TestStartTime.Unix(),
		TestTime:      data.TestTime.Unix(),
		Extra:         extra,
	}

	var out bytes.Buffer
	if err = t.ExecuteTemplate(&out, "main", variables); err != nil {
		return "", err
	}
	return out.String(), nil
}