lib/go-atscfg/chkconfig.go

package atscfg

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */

import (
	"encoding/json"
	"sort"

	"github.com/apache/trafficcontrol/lib/go-tc"
)

const ChkconfigFileName = `chkconfig`
const ChkconfigParamConfigFile = `chkconfig`
const ContentTypeChkconfig = ContentTypeTextASCII
const LineCommentChkconfig = LineCommentHash

// MakeChkconfig returns the 'chkconfig' ATS config file endpoint.
// This is a JSON object, and should be served with an 'application/json' Content-Type.
func MakeChkconfig(
	serverParams []tc.Parameter,
) (Cfg, error) {
	warnings := []string{}

	serverParams = filterParams(serverParams, ChkconfigParamConfigFile, "", "", "")

	chkconfig := []chkConfigEntry{}
	for _, param := range serverParams {
		chkconfig = append(chkconfig, chkConfigEntry{Name: param.Name, Val: param.Value})
	}

	sort.Sort(chkConfigEntries(chkconfig))

	bts, err := json.Marshal(&chkconfig)
	if err != nil {
		return Cfg{}, makeErr(warnings, "marshalling chkconfig NameVals: "+err.Error())
	}

	return Cfg{
		Text:        string(bts),
		ContentType: ContentTypeChkconfig,
		LineComment: LineCommentChkconfig,
		Warnings:    warnings,
	}, nil
}

type chkConfigEntry struct {
	Name string
	Val  string
}

type chkConfigEntries []chkConfigEntry

func (e chkConfigEntries) Len() int { return len(e) }
func (e chkConfigEntries) Less(i, j int) bool {
	if e[i].Name != e[j].Name {
		return e[i].Name < e[j].Name
	}
	return e[i].Val < e[j].Val
}
func (e chkConfigEntries) Swap(i, j int) { e[i], e[j] = e[j], e[i] }