审查视图

vendor/github.com/gavv/httpexpect/string.go 8.2 KB
tangxvhui authored
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
package httpexpect

import (
	"net/http"
	"regexp"
	"strings"
	"time"
)

// String provides methods to inspect attached string value
// (Go representation of JSON string).
type String struct {
	chain chain
	value string
}

// NewString returns a new String given a reporter used to report failures
// and value to be inspected.
//
// reporter should not be nil.
//
// Example:
//  str := NewString(t, "Hello")
func NewString(reporter Reporter, value string) *String {
	return &String{makeChain(reporter), value}
}

// Raw returns underlying value attached to String.
// This is the value originally passed to NewString.
//
// Example:
//  str := NewString(t, "Hello")
//  assert.Equal(t, "Hello", str.Raw())
func (s *String) Raw() string {
	return s.value
}

// Path is similar to Value.Path.
func (s *String) Path(path string) *Value {
	return getPath(&s.chain, s.value, path)
}

// Schema is similar to Value.Schema.
func (s *String) Schema(schema interface{}) *String {
	checkSchema(&s.chain, s.value, schema)
	return s
}

// Length returns a new Number object that may be used to inspect string length.
//
// Example:
//  str := NewString(t, "Hello")
//  str.Length().Equal(5)
func (s *String) Length() *Number {
	return &Number{s.chain, float64(len(s.value))}
}

// DateTime parses date/time from string an returns a new DateTime object.
//
// If layout is given, DateTime() uses time.Parse() with given layout.
// Otherwise, it uses http.ParseTime(). If pasing error occurred,
// DateTime reports failure and returns empty (but non-nil) object.
//
// Example:
//   str := NewString(t, "Tue, 15 Nov 1994 08:12:31 GMT")
//   str.DateTime().Lt(time.Now())
//
//   str := NewString(t, "15 Nov 94 08:12 GMT")
//   str.DateTime(time.RFC822).Lt(time.Now())
func (s *String) DateTime(layout ...string) *DateTime {
	if s.chain.failed() {
		return &DateTime{s.chain, time.Unix(0, 0)}
	}
	var (
		t   time.Time
		err error
	)
	if len(layout) != 0 {
		t, err = time.Parse(layout[0], s.value)
	} else {
		t, err = http.ParseTime(s.value)
	}
	if err != nil {
		s.chain.fail(err.Error())
		return &DateTime{s.chain, time.Unix(0, 0)}
	}
	return &DateTime{s.chain, t}
}

// Empty succeeds if string is empty.
//
// Example:
//  str := NewString(t, "")
//  str.Empty()
func (s *String) Empty() *String {
	return s.Equal("")
}

// NotEmpty succeeds if string is non-empty.
//
// Example:
//  str := NewString(t, "Hello")
//  str.NotEmpty()
func (s *String) NotEmpty() *String {
	return s.NotEqual("")
}

// Equal succeeds if string is equal to given Go string.
//
// Example:
//  str := NewString(t, "Hello")
//  str.Equal("Hello")
func (s *String) Equal(value string) *String {
	if !(s.value == value) {
		s.chain.fail("\nexpected string equal to:\n %q\n\nbut got:\n %q",
			value, s.value)
	}
	return s
}

// NotEqual succeeds if string is not equal to given Go string.
//
// Example:
//  str := NewString(t, "Hello")
//  str.NotEqual("Goodbye")
func (s *String) NotEqual(value string) *String {
	if !(s.value != value) {
		s.chain.fail("\nexpected string not equal to:\n %q", value)
	}
	return s
}

// EqualFold succeeds if string is equal to given Go string after applying Unicode
// case-folding (so it's a case-insensitive match).
//
// Example:
//  str := NewString(t, "Hello")
//  str.EqualFold("hELLo")
func (s *String) EqualFold(value string) *String {
	if !strings.EqualFold(s.value, value) {
		s.chain.fail(
			"\nexpected string equal to (case-insensitive):\n %q\n\nbut got:\n %q",
			value, s.value)
	}
	return s
}

// NotEqualFold succeeds if string is not equal to given Go string after applying
// Unicode case-folding (so it's a case-insensitive match).
//
// Example:
//  str := NewString(t, "Hello")
//  str.NotEqualFold("gOODBYe")
func (s *String) NotEqualFold(value string) *String {
	if strings.EqualFold(s.value, value) {
		s.chain.fail(
			"\nexpected string not equal to (case-insensitive):\n %q\n\nbut got:\n %q",
			value, s.value)
	}
	return s
}

// Contains succeeds if string contains given Go string as a substring.
//
// Example:
//  str := NewString(t, "Hello")
//  str.Contains("ell")
func (s *String) Contains(value string) *String {
	if !strings.Contains(s.value, value) {
		s.chain.fail(
			"\nexpected string containing substring:\n %q\n\nbut got:\n %q",
			value, s.value)
	}
	return s
}

// NotContains succeeds if string doesn't contain Go string as a substring.
//
// Example:
//  str := NewString(t, "Hello")
//  str.NotContains("bye")
func (s *String) NotContains(value string) *String {
	if strings.Contains(s.value, value) {
		s.chain.fail(
			"\nexpected string not containing substring:\n %q\n\nbut got:\n %q",
			value, s.value)
	}
	return s
}

// ContainsFold succeeds if string contains given Go string as a substring after
// applying Unicode case-folding (so it's a case-insensitive match).
//
// Example:
//  str := NewString(t, "Hello")
//  str.ContainsFold("ELL")
func (s *String) ContainsFold(value string) *String {
	if !strings.Contains(strings.ToLower(s.value), strings.ToLower(value)) {
		s.chain.fail(
			"\nexpected string containing substring (case-insensitive):\n %q"+
				"\n\nbut got:\n %q", value, s.value)
	}
	return s
}

// NotContainsFold succeeds if string doesn't contain given Go string as a substring
// after applying Unicode case-folding (so it's a case-insensitive match).
//
// Example:
//  str := NewString(t, "Hello")
//  str.NotContainsFold("BYE")
func (s *String) NotContainsFold(value string) *String {
	if strings.Contains(strings.ToLower(s.value), strings.ToLower(value)) {
		s.chain.fail(
			"\nexpected string not containing substring (case-insensitive):\n %q"+
				"\n\nbut got:\n %q", value, s.value)
	}
	return s
}

// Match matches the string with given regexp and returns a new Match object
// with found submatches.
//
// If regexp is invalid or string doesn't match regexp, Match fails and returns
// empty (but non-nil) object. regexp.Compile is used to construct regexp, and
// Regexp.FindStringSubmatch is used to construct matches.
//
// Example:
//   s := NewString(t, "http://example.com/users/john")
//   m := s.Match(`http://(?P<host>.+)/users/(?P<user>.+)`)
//
//   m.NotEmpty()
//   m.Length().Equal(3)
//
//   m.Index(0).Equal("http://example.com/users/john")
//   m.Index(1).Equal("example.com")
//   m.Index(2).Equal("john")
//
//   m.Name("host").Equal("example.com")
//   m.Name("user").Equal("john")
func (s *String) Match(re string) *Match {
	r, err := regexp.Compile(re)
	if err != nil {
		s.chain.fail(err.Error())
		return makeMatch(s.chain, nil, nil)
	}

	m := r.FindStringSubmatch(s.value)
	if m == nil {
		s.chain.fail("\nexpected string matching regexp:\n `%s`\n\nbut got:\n %q",
			re, s.value)
		return makeMatch(s.chain, nil, nil)
	}

	return makeMatch(s.chain, m, r.SubexpNames())
}

// MatchAll find all matches in string for given regexp and returns a list
// of found matches.
//
// If regexp is invalid or string doesn't match regexp, MatchAll fails and
// returns empty (but non-nil) slice. regexp.Compile is used to construct
// regexp, and Regexp.FindAllStringSubmatch is used to find matches.
//
// Example:
//   s := NewString(t,
//      "http://example.com/users/john http://example.com/users/bob")
//
//   m := s.MatchAll(`http://(?P<host>\S+)/users/(?P<user>\S+)`)
//
//   m[0].Name("user").Equal("john")
//   m[1].Name("user").Equal("bob")
func (s *String) MatchAll(re string) []Match {
	r, err := regexp.Compile(re)
	if err != nil {
		s.chain.fail(err.Error())
		return []Match{}
	}

	matches := r.FindAllStringSubmatch(s.value, -1)
	if matches == nil {
		s.chain.fail("\nexpected string matching regexp:\n `%s`\n\nbut got:\n %q",
			re, s.value)
		return []Match{}
	}

	ret := []Match{}
	for _, m := range matches {
		ret = append(ret, *makeMatch(
			s.chain,
			m,
			r.SubexpNames()))
	}

	return ret
}

// NotMatch succeeds if the string doesn't match to given regexp.
//
// regexp.Compile is used to construct regexp, and Regexp.MatchString
// is used to perform match.
//
// Example:
//   s := NewString(t, "a")
//   s.NotMatch(`[^a]`)
func (s *String) NotMatch(re string) *String {
	r, err := regexp.Compile(re)
	if err != nil {
		s.chain.fail(err.Error())
		return s
	}

	if r.MatchString(s.value) {
		s.chain.fail("\nexpected string not matching regexp:\n `%s`\n\nbut got:\n %q",
			re, s.value)
		return s
	}

	return s
}