Skip to content

Commit

Permalink
add the unit tests
Browse files Browse the repository at this point in the history
  • Loading branch information
@WakeupTsai
WakeupTsai committed Aug 21, 2018
1 parent 14546f9 commit 6f86cba
Show file tree
Hide file tree
Showing 3 changed files with 473 additions and 0 deletions.
389 changes: 389 additions & 0 deletions src/container/contaiiner_test.go
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,389 @@
// 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 container

import (
"reflect"
"testing"

"k8s.io/api/core/v1"
)

var log1 = LogLine{
Timestamp: "1",
Content: "log1",
}

var log2 = LogLine{
Timestamp: "2",
Content: "log2",
}

var log3 = LogLine{
Timestamp: "3",
Content: "log3",
}

var log4 = LogLine{
Timestamp: "4",
Content: "log4",
}

var log5 = LogLine{
Timestamp: "5",
Content: "log5",
}

func TestGetLogs(t *testing.T) {
// for the test cases, the line read limit is reduced to 10
lineReadLimit = int64(10)
cases := []struct {
info string
podId string
rawLogs string
container string
logSelector *Selection
expected *LogDetails
}{
{
"return no logs if no logs are available",
"",
"",
"",
AllSelection,
&LogDetails{
Info: LogInfo{
PodName: "",
ContainerName: "",
},
LogLines: ToLogLines(""),
},
},
{
"return all logs if selected all logs",
"pod-1",
"1 log1\n2 log2\n3 log3\n4 log4\n5 log5",
"test",
AllSelection,
&LogDetails{
Info: LogInfo{
PodName: "pod-1",
ContainerName: "test",
FromDate: "1",
ToDate: "5",
},
LogLines: LogLines{log1, log2, log3, log4, log5},
Selection: Selection{
ReferencePoint: LogLineId{
LogTimestamp: "3",
LineNum: -1,
},
OffsetFrom: -2,
OffsetTo: 3},
},
},
{
"return a slice relative to the first element",
"pod-1",
"1 log1\n2 log2\n3 log3\n4 log4\n5 log5",
"test",
&Selection{
ReferencePoint: OldestLogLineId,
OffsetFrom: 1,
OffsetTo: 3,
},
&LogDetails{
Info: LogInfo{
PodName: "pod-1",
ContainerName: "test",
FromDate: "2",
ToDate: "3",
},
LogLines: LogLines{log2, log3},
Selection: Selection{
ReferencePoint: LogLineId{
LogTimestamp: "3",
LineNum: -1,
},
OffsetFrom: -1,
OffsetTo: 1},
},
},
{
"return a slice relative to the last element",
"pod-1",
"1 log1\n2 log2\n3 log3\n4 log4\n5 log5",
"test",
&Selection{
ReferencePoint: NewestLogLineId,
OffsetFrom: -3,
OffsetTo: -1,
},
&LogDetails{
Info: LogInfo{
PodName: "pod-1",
ContainerName: "test",
FromDate: "2",
ToDate: "3",
},
LogLines: LogLines{log2, log3},
Selection: Selection{
ReferencePoint: LogLineId{
LogTimestamp: "3",
LineNum: -1,
},
OffsetFrom: -1,
OffsetTo: 1},
},
},
{
"return a slice relative to an arbitrary element",
"pod-1",
"1 log1\n2 log2\n3 log3\n4 log4\n5 log5",
"test",
&Selection{
ReferencePoint: LogLineId{
LogTimestamp: LogTimestamp("4"),
LineNum: 1,
},
OffsetFrom: -2,
OffsetTo: 0,
},
&LogDetails{
Info: LogInfo{
PodName: "pod-1",
ContainerName: "test",
FromDate: "2",
ToDate: "3",
},
LogLines: LogLines{log2, log3},
Selection: Selection{
ReferencePoint: LogLineId{
LogTimestamp: "3",
LineNum: -1,
},
OffsetFrom: -1,
OffsetTo: 1},
},
},
{
"return a slice outside of log bounds - try to keep requested size",
"pod-1",
"1 log1\n2 log2\n3 log3\n4 log4\n5 log5",
"test",
&Selection{
ReferencePoint: LogLineId{
LogTimestamp: LogTimestamp("4"),
LineNum: 1,
},
OffsetFrom: 1,
OffsetTo: 3,
},
&LogDetails{
Info: LogInfo{
PodName: "pod-1",
ContainerName: "test",
FromDate: "4",
ToDate: "5",
},
LogLines: LogLines{log4, log5},
Selection: Selection{
ReferencePoint: LogLineId{
LogTimestamp: "3",
LineNum: -1,
},
OffsetFrom: 1,
OffsetTo: 3},
},
},
{
"return a slice outside of log bounds - try to keep requested size",
"pod-1",
"1 log1\n2 log2\n3 log3\n4 log4\n5 log5",
"test",
&Selection{
ReferencePoint: LogLineId{
LogTimestamp: LogTimestamp("4"),
LineNum: 1,
},
OffsetFrom: -50,
OffsetTo: -48,
},
&LogDetails{
Info: LogInfo{
PodName: "pod-1",
ContainerName: "test",
FromDate: "1",
ToDate: "2",
},
LogLines: LogLines{log1, log2},
Selection: Selection{
ReferencePoint: LogLineId{
LogTimestamp: "3",
LineNum: -1,
},
OffsetFrom: -2,
OffsetTo: 0},
},
},
{
"be able to handle duplicate timestamps",
"pod-1",
"1 log1\n1 log2\n1 log3\n1 log4\n1 log5",
"test",
&Selection{
ReferencePoint: LogLineId{
LogTimestamp: LogTimestamp("1"),
LineNum: 2, // this means element with actual index 1.
},
OffsetFrom: 0,
OffsetTo: 2, // request indices 1, 2
},
&LogDetails{
Info: LogInfo{
PodName: "pod-1",
ContainerName: "test",
FromDate: "1",
ToDate: "1",
},
LogLines: LogLines{LogLine{
Timestamp: "1",
Content: "log2",
}, LogLine{
Timestamp: "1",
Content: "log3",
}},
Selection: Selection{
ReferencePoint: LogLineId{
LogTimestamp: "1",
LineNum: 3,
},
OffsetFrom: -1,
OffsetTo: 1},
},
},
{
"set truncated flag if read limit is reached",
"pod-1",
"1 log1\n2 log2\n3 log3\n4 log4\n5 log5\n6 log6\n7 log7\n8 log8\n9 log9\n10 log10",
"test",
&Selection{
ReferencePoint: LogLineId{
LogTimestamp: LogTimestamp("5"),
LineNum: 1,
},
OffsetFrom: -10,
OffsetTo: -8, // request indices ouside (beginning) of available log lines
LogFilePosition: "end",
},
&LogDetails{
Info: LogInfo{
PodName: "pod-1",
ContainerName: "test",
FromDate: "1",
ToDate: "2",
Truncated: true, // Read limit is set to 10. Log lines could not be loaded
},
LogLines: LogLines{LogLine{ // Last available page of logs is returned
Timestamp: "1",
Content: "log1",
}, LogLine{
Timestamp: "2",
Content: "log2",
}},
Selection: Selection{
ReferencePoint: LogLineId{
LogTimestamp: "6",
LineNum: -1,
},
OffsetFrom: -5,
OffsetTo: -3,
LogFilePosition: "end",
},
},
},
{
"don't try to split timestamp for error message",
"pod-1",
"an error message from api server",
"test",
AllSelection,
&LogDetails{
Info: LogInfo{
PodName: "pod-1",
ContainerName: "test",
FromDate: "0",
ToDate: "0",
},
LogLines: LogLines{LogLine{
Timestamp: "0",
Content: "an error message from api server",
}},
Selection: Selection{
ReferencePoint: LogLineId{
LogTimestamp: "0",
LineNum: 1,
},
OffsetFrom: 0,
OffsetTo: 1},
},
},
}
for _, c := range cases {
actual := ConstructLogDetails(c.podId, c.rawLogs, c.container, c.logSelector)
if !reflect.DeepEqual(actual, c.expected) {
t.Errorf("Test Case: %s.\nReceived: %#v \nExpected: %#v\n\n", c.info, actual, c.expected)
}

}
}
func TestMapToLogOptions(t *testing.T) {
cases := []struct {
info string
container string
logSelector *Selection
expected *v1.PodLogOptions
}{
{"Byte limit must be set, when reading the log file from the beginning",
"test",
&Selection{
LogFilePosition: "beginning",
},
&v1.PodLogOptions{
Container: "test",
Timestamps: true,
LimitBytes: &byteReadLimit,
},
},
{"Line limit must be set, when reading the log file from the end",
"test",
&Selection{
LogFilePosition: "end",
},
&v1.PodLogOptions{
Container: "test",
Timestamps: true,
TailLines: &lineReadLimit,
},
},
}
for _, c := range cases {
actual := mapToLogOptions(c.container, c.logSelector, false)
if !reflect.DeepEqual(actual, c.expected) {
t.Errorf("Test Case: %s.\nReceived: %#v \nExpected: %#v\n\n", c.info, actual, c.expected)
}

}
}
Loading

0 comments on commit 6f86cba

Please sign in to comment.