1- // Copyright (c) 2016 Uber Technologies, Inc.
1+ // Copyright (c) 2016-2022 Uber Technologies, Inc.
22//
33// Permission is hereby granted, free of charge, to any person obtaining a copy
44// of this software and associated documentation files (the "Software"), to deal
@@ -23,14 +23,15 @@ package zap
2323import (
2424 "errors"
2525 "io"
26+ "io/fs"
2627 "net/url"
2728 "os"
2829 "path/filepath"
29- "strings"
3030 "testing"
3131
3232 "github.com/stretchr/testify/assert"
3333 "github.com/stretchr/testify/require"
34+ "go.uber.org/multierr"
3435 "go.uber.org/zap/zapcore"
3536)
3637
@@ -50,55 +51,95 @@ func TestOpenNoPaths(t *testing.T) {
5051func TestOpen (t * testing.T ) {
5152 tempName := filepath .Join (t .TempDir (), "test.log" )
5253 assert .False (t , fileExists (tempName ))
53- require .True (t , strings . HasPrefix (tempName , "/" ), "Expected absolute temp file path." )
54+ require .True (t , filepath . IsAbs (tempName ), "Expected absolute temp file path." )
5455
5556 tests := []struct {
57+ msg string
5658 paths []string
57- errs []string
5859 }{
59- {[]string {"stdout" }, nil },
60- {[]string {"stderr" }, nil },
61- {[]string {tempName }, nil },
62- {[]string {"file://" + tempName }, nil },
63- {[]string {"file://localhost" + tempName }, nil },
64- {[]string {"/foo/bar/baz" }, []string {"open /foo/bar/baz: no such file or directory" }},
65- {[]string {"file://localhost/foo/bar/baz" }, []string {"open /foo/bar/baz: no such file or directory" }},
6660 {
67- paths : []string {"stdout" , "/foo/bar/baz" , tempName , "file:///baz/quux" },
68- errs : []string {
69- "open /foo/bar/baz: no such file or directory" ,
70- "open /baz/quux: no such file or directory" ,
71- },
61+ msg : "stdout" ,
62+ paths : []string {"stdout" },
63+ },
64+ {
65+ msg : "stderr" ,
66+ paths : []string {"stderr" },
67+ },
68+ {
69+ msg : "temp file path only" ,
70+ paths : []string {tempName },
71+ },
72+ {
73+ msg : "temp file file scheme" ,
74+ paths : []string {"file://" + tempName },
75+ },
76+ {
77+ msg : "temp file with file scheme and host localhost" ,
78+ paths : []string {"file://localhost" + tempName },
7279 },
73- {[]string {"file:///stderr" }, []string {"open /stderr:" }},
74- {[]string {"file:///stdout" }, []string {"open /stdout:" }},
75- {[]string {"file://host01.test.com" + tempName }, []string {"empty or use localhost" }},
76- {[]string {"file://rms@localhost" + tempName }, []string {"user and password not allowed" }},
77- {[]string {"file://localhost" + tempName + "#foo" }, []string {"fragments not allowed" }},
78- {[]string {"file://localhost" + tempName + "?foo=bar" }, []string {"query parameters not allowed" }},
79- {[]string {"file://localhost:8080" + tempName }, []string {"ports not allowed" }},
8080 }
8181
8282 for _ , tt := range tests {
83- _ , cleanup , err := Open (tt .paths ... )
84- if err == nil {
85- defer cleanup ()
86- }
83+ t .Run (tt .msg , func (t * testing.T ) {
84+ _ , cleanup , err := Open (tt .paths ... )
85+ if err == nil {
86+ defer cleanup ()
87+ }
8788
88- if len (tt .errs ) == 0 {
8989 assert .NoError (t , err , "Unexpected error opening paths %v." , tt .paths )
90- } else {
91- msg := err .Error ()
92- for _ , expect := range tt .errs {
93- assert .Contains (t , msg , expect , "Unexpected error opening paths %v." , tt .paths )
94- }
95- }
90+ })
9691 }
9792
9893 assert .True (t , fileExists (tempName ))
9994 os .Remove (tempName )
10095}
10196
97+ func TestOpenPathsNotFound (t * testing.T ) {
98+ tempName := filepath .Join (t .TempDir (), "test.log" )
99+
100+ tests := []struct {
101+ msg string
102+ paths []string
103+ wantNotFoundPaths []string
104+ }{
105+ {
106+ msg : "missing path" ,
107+ paths : []string {"/foo/bar/baz" },
108+ wantNotFoundPaths : []string {"/foo/bar/baz" },
109+ },
110+ {
111+ msg : "missing file scheme url with host localhost" ,
112+ paths : []string {"file://localhost/foo/bar/baz" },
113+ wantNotFoundPaths : []string {"/foo/bar/baz" },
114+ },
115+ {
116+ msg : "multiple paths" ,
117+ paths : []string {"stdout" , "/foo/bar/baz" , tempName , "file:///baz/quux" },
118+ wantNotFoundPaths : []string {
119+ "/foo/bar/baz" ,
120+ "/baz/quux" ,
121+ },
122+ },
123+ }
124+
125+ for _ , tt := range tests {
126+ t .Run (tt .msg , func (t * testing.T ) {
127+ _ , cleanup , err := Open (tt .paths ... )
128+ if ! assert .Error (t , err , "Open must fail." ) {
129+ cleanup ()
130+ return
131+ }
132+
133+ errs := multierr .Errors (err )
134+ require .Len (t , errs , len (tt .wantNotFoundPaths ))
135+ for i , err := range errs {
136+ assert .ErrorIs (t , err , fs .ErrNotExist )
137+ assert .ErrorContains (t , err , tt .wantNotFoundPaths [i ], "missing path in error" )
138+ }
139+ })
140+ }
141+ }
142+
102143func TestOpenRelativePath (t * testing.T ) {
103144 const name = "test-relative-path.txt"
104145
@@ -136,6 +177,54 @@ func TestOpenFails(t *testing.T) {
136177 }
137178}
138179
180+ func TestOpenOtherErrors (t * testing.T ) {
181+ tempName := filepath .Join (t .TempDir (), "test.log" )
182+
183+ tests := []struct {
184+ msg string
185+ paths []string
186+ wantErr string
187+ }{
188+ {
189+ msg : "file with unexpected host" ,
190+ paths : []string {"file://host01.test.com" + tempName },
191+ wantErr : "empty or use localhost" ,
192+ },
193+ {
194+ msg : "file with user on localhost" ,
195+ paths : []string {"file://rms@localhost" + tempName },
196+ wantErr : "user and password not allowed" ,
197+ },
198+ {
199+ msg : "file url with fragment" ,
200+ paths : []string {"file://localhost" + tempName + "#foo" },
201+ wantErr : "fragments not allowed" ,
202+ },
203+ {
204+ msg : "file url with query" ,
205+ paths : []string {"file://localhost" + tempName + "?foo=bar" },
206+ wantErr : "query parameters not allowed" ,
207+ },
208+ {
209+ msg : "file with port" ,
210+ paths : []string {"file://localhost:8080" + tempName },
211+ wantErr : "ports not allowed" ,
212+ },
213+ }
214+
215+ for _ , tt := range tests {
216+ t .Run (tt .msg , func (t * testing.T ) {
217+ _ , cleanup , err := Open (tt .paths ... )
218+ if ! assert .Error (t , err , "Open must fail." ) {
219+ cleanup ()
220+ return
221+ }
222+
223+ assert .ErrorContains (t , err , tt .wantErr , "Unexpected error opening paths %v." , tt .paths )
224+ })
225+ }
226+ }
227+
139228type testWriter struct {
140229 expected string
141230 t testing.TB
0 commit comments