rob05c closed pull request #1844: DeepCachingType -- "NEVER" is now default
URL: https://github.com/apache/incubator-trafficcontrol/pull/1844
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/lib/go-tc/enum.go b/lib/go-tc/enum.go
index f8f3a6610a..da9dcf1730 100644
--- a/lib/go-tc/enum.go
+++ b/lib/go-tc/enum.go
@@ -29,6 +29,7 @@ package tc
*/
import (
+ "encoding/json"
"errors"
"strconv"
"strings"
@@ -189,9 +190,9 @@ func CacheStatusFromString(s string) CacheStatus {
type DeepCachingType string
const (
+ DeepCachingTypeNever = DeepCachingType("") // default value
DeepCachingTypeAlways = DeepCachingType("ALWAYS")
- DeepCachingTypeNever = DeepCachingType("NEVER")
- DeepCachingTypeInvalid = DeepCachingType("")
+ DeepCachingTypeInvalid = DeepCachingType("INVALID")
)
// String returns a string representation of this deep caching type
@@ -200,7 +201,7 @@ func (t DeepCachingType) String() string {
case DeepCachingTypeAlways:
return string(t)
case DeepCachingTypeNever:
- return string(t)
+ return "NEVER"
default:
return "INVALID"
}
@@ -213,6 +214,9 @@ func DeepCachingTypeFromString(s string) DeepCachingType {
return DeepCachingTypeAlways
case "never":
return DeepCachingTypeNever
+ case "":
+ // default when omitted
+ return DeepCachingTypeNever
default:
return DeepCachingTypeInvalid
}
@@ -230,3 +234,8 @@ func (t *DeepCachingType) UnmarshalJSON(data []byte) error {
}
return nil
}
+
+// MarshalJSON marshals into a JSON representation
+func (t DeepCachingType) MarshalJSON() ([]byte, error) {
+ return json.Marshal(t.String())
+}
diff --git a/lib/go-tc/enum_test.go b/lib/go-tc/enum_test.go
new file mode 100644
index 0000000000..e11e35b197
--- /dev/null
+++ b/lib/go-tc/enum_test.go
@@ -0,0 +1,75 @@
+package tc
+
+/*
+ * 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"
+ "testing"
+)
+
+func TestDeepCachingType(t *testing.T) {
+ var d DeepCachingType
+ c := d.String()
+ if c != "NEVER" {
+ t.Errorf(`Default "%s" expected to be "NEVER"`, c)
+ }
+
+ tests := map[string]string{
+ "": "NEVER",
+ "NEVER": "NEVER",
+ "ALWAYS": "ALWAYS",
+ "never": "NEVER",
+ "always": "ALWAYS",
+ "Never": "NEVER",
+ "AlwayS": "ALWAYS",
+ " ": "INVALID",
+ "NEVERALWAYS": "INVALID",
+ "ALWAYSNEVER": "INVALID",
+ }
+
+ for in, exp := range tests {
+ dc := DeepCachingTypeFromString(in)
+ got, err := json.Marshal(dc)
+ if err != nil {
+ t.Errorf("%v", err)
+ }
+
+ if string(got) != `"`+exp+`"` {
+ t.Errorf("for %s, expected %s, got %s", in, exp, got)
+ }
+ var new DeepCachingType
+ json.Unmarshal(got, &new)
+ if new != dc {
+ t.Errorf("Expected %v, got %v", dc, new)
+ }
+ }
+
+ // make sure we get the right default when marshalled within a new
delivery service
+ var ds DeliveryService
+ txt, err := json.MarshalIndent(ds, ``, ` `)
+ if err != nil {
+ t.Errorf(err.Error())
+ }
+ t.Log(string(txt))
+ c = ds.DeepCachingType.String()
+ if c != "NEVER" {
+ t.Errorf(`Default "%s" expected to be "NEVER"`, c)
+ }
+}
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
