benchmark/pkg/metricsfetcher/util/mock_util.go

/*
Copyright 2017 The Kubernetes Authors.

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 util

import (
	"fmt"
)

// MockJobLogUtils mocks out all moving parts of JobLogUtils, like use of
// network or reading of files.
type MockJobLogUtils struct {
	JobLogUtils
	MockBuildNumbers     []int
	MockStartTimestamps  map[int]uint64
	MockFinishedStatuses map[int]bool
	MockFileContents     map[int]map[string][]byte
	MockFilesWithPrefix  map[int]map[string][]string
}

// GetLatestBuildNumberForJob returns latest build number for the job.
func (utils MockJobLogUtils) GetLatestBuildNumberForJob(job string) (int, error) {
	length := len(utils.MockBuildNumbers)
	if length == 0 {
		return 0, fmt.Errorf("array of mock build numbers is empty")
	}
	return utils.MockBuildNumbers[length-1], nil
}

// GetBuildNumbersForJob return list of build numbers.
func (utils MockJobLogUtils) GetBuildNumbersForJob(job string) ([]int, error) {
	return utils.MockBuildNumbers, nil
}

// GetJobRunStartTimestamp returns start timestamp for the job run.
func (utils MockJobLogUtils) GetJobRunStartTimestamp(job string, run int) (uint64, error) {
	value, ok := utils.MockStartTimestamps[run]
	if !ok {
		return 0, fmt.Errorf("run number %v not a key in the mock start timestamps map", run)
	}
	return value, nil
}

// GetJobRunFinishedStatus returns the finished status (true/false) for the job run.
func (utils MockJobLogUtils) GetJobRunFinishedStatus(job string, run int) (bool, error) {
	value, ok := utils.MockFinishedStatuses[run]
	if !ok {
		return false, fmt.Errorf("run number %v not a key in the mock finished statuses map", run)
	}
	return value, nil
}

// GetJobRunFileContents returns the contents of the file given by filepath (relative to run's root dir).
func (utils MockJobLogUtils) GetJobRunFileContents(job string, run int, filepath string) ([]byte, error) {
	files, ok := utils.MockFileContents[run]
	if !ok {
		return nil, fmt.Errorf("run number %v not a 1st key in the mock file contents map", run)
	}
	file, ok := files[filepath]
	if !ok {
		return nil, fmt.Errorf("filepath %v not a 2nd key in the mock file contents map for 1st key %v", filepath, run)
	}
	return file, nil
}

// ListJobRunFilesWithPrefix returns the list of files with a given path prefix in the job run's root dir.
func (utils MockJobLogUtils) ListJobRunFilesWithPrefix(job string, run int, prefix string) ([]string, error) {
	filesWithPrefixes, ok := utils.MockFilesWithPrefix[run]
	if !ok {
		return nil, fmt.Errorf("run number %v not a 1st key in the mock files with prefix map", run)
	}
	filesWithPrefix, ok := filesWithPrefixes[prefix]
	return filesWithPrefix, nil
}