Skip to content

Commit 43f7d9f

Browse files
hslatmanhslatman
authored
Merge pull request #490 from smallstep/herman/fix-read-from-stdin
Support reading from STDIN in `ReadFile`
2 parents 9ff3470 + 5d61907 commit 43f7d9f

File tree

7 files changed

+809
-18
lines changed

7 files changed

+809
-18
lines changed

‎internal/utils/io.go‎

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,13 @@ package utils
22

33
import (
44
"bytes"
5+
"io"
56
"os"
67
"unicode"
78

89
"github.com/pkg/errors"
10+
11+
"go.step.sm/crypto/internal/utils/utfbom"
912
)
1013

1114
func maybeUnwrap(err error) error {
@@ -15,15 +18,32 @@ func maybeUnwrap(err error) error {
1518
return err
1619
}
1720

18-
// ReadFile reads the file named by filename and returns the contents.
19-
//
20-
// It wraps os.ReadFile wrapping the errors.
21-
func ReadFile(filename string) ([]byte, error) {
22-
b, err := os.ReadFile(filename)
21+
// stdinFilename is the name of the file that is used in many command
22+
// line utilities to denote input is to be read from STDIN.
23+
const stdinFilename = "-"
24+
25+
// stdin points to STDIN through os.Stdin.
26+
var stdin = os.Stdin
27+
28+
// ReadFile reads the file identified by filename and returns
29+
// the contents. If filename is equal to "-", it will read from
30+
// STDIN.
31+
func ReadFile(filename string) (b []byte, err error) {
32+
if filename == stdinFilename {
33+
filename = "/dev/stdin"
34+
b, err = io.ReadAll(stdin)
35+
} else {
36+
var contents []byte
37+
contents, err = os.ReadFile(filename)
38+
if err != nil {
39+
return nil, errors.Wrapf(maybeUnwrap(err), "error reading %q", filename)
40+
}
41+
b, err = io.ReadAll(utfbom.SkipOnly(bytes.NewReader(contents)))
42+
}
2343
if err != nil {
24-
return nil, errors.Wrapf(maybeUnwrap(err), "error reading %s", filename)
44+
return nil, errors.Wrapf(maybeUnwrap(err), "error reading %q", filename)
2545
}
26-
return b, nil
46+
return
2747
}
2848

2949
// ReadPasswordFromFile reads and returns the password from the given filename.

‎internal/utils/io_test.go‎

Lines changed: 72 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
package utils
22

33
import (
4-
"fmt"
4+
"io"
55
"os"
66
"path/filepath"
77
"reflect"
88
"testing"
99

1010
"github.com/pkg/errors"
11+
"github.com/stretchr/testify/require"
1112
)
1213

1314
func TestReadFile(t *testing.T) {
@@ -37,6 +38,62 @@ func TestReadFile(t *testing.T) {
3738
}
3839
}
3940

41+
// Set content to be read from mock STDIN
42+
func setStdinContent(t *testing.T, content string) (cleanup func()) {
43+
f, err := os.CreateTemp("" /* dir */, "utils-read-test")
44+
require.NoError(t, err)
45+
_, err = f.WriteString(content)
46+
require.NoError(t, err)
47+
_, err = f.Seek(0, io.SeekStart)
48+
require.NoError(t, err)
49+
old := stdin
50+
stdin = f
51+
52+
return func() {
53+
stdin = old
54+
require.NoError(t, f.Close())
55+
require.NoError(t, os.Remove(f.Name()))
56+
}
57+
}
58+
59+
func TestReadFromStdin(t *testing.T) {
60+
cleanup := setStdinContent(t, "input on STDIN")
61+
t.Cleanup(func() {
62+
cleanup()
63+
})
64+
65+
b, err := ReadFile(stdinFilename)
66+
require.NoError(t, err)
67+
require.Equal(t, "input on STDIN", string(b))
68+
}
69+
70+
// Sets STDIN to a file that is already closed, and thus fails
71+
// to be read from.
72+
func setFailingStdin(t *testing.T) (cleanup func()) {
73+
f, err := os.CreateTemp("" /* dir */, "utils-read-test")
74+
require.NoError(t, err)
75+
err = f.Close()
76+
require.NoError(t, err)
77+
old := stdin
78+
stdin = f
79+
80+
return func() {
81+
stdin = old
82+
require.NoError(t, os.Remove(f.Name()))
83+
}
84+
}
85+
86+
func TestReadFromStdinFails(t *testing.T) {
87+
cleanup := setFailingStdin(t)
88+
t.Cleanup(func() {
89+
cleanup()
90+
})
91+
92+
b, err := ReadFile(stdinFilename)
93+
require.Error(t, err)
94+
require.Empty(t, b)
95+
}
96+
4097
func TestReadPasswordFromFile(t *testing.T) {
4198
type args struct {
4299
filename string
@@ -65,11 +122,20 @@ func TestReadPasswordFromFile(t *testing.T) {
65122
}
66123
}
67124

125+
func TestReadPasswordFromStdin(t *testing.T) {
126+
cleanup := setStdinContent(t, "this-is-a-secret-testing-password")
127+
t.Cleanup(func() {
128+
cleanup()
129+
})
130+
131+
b, err := ReadPasswordFromFile(stdinFilename)
132+
require.NoError(t, err)
133+
require.Equal(t, "this-is-a-secret-testing-password", string(b))
134+
}
135+
68136
func TestWriteFile(t *testing.T) {
69137
tmpDir, err := os.MkdirTemp(os.TempDir(), "go-tests")
70-
if err != nil {
71-
t.Fatal(err)
72-
}
138+
require.NoError(t, err)
73139
t.Cleanup(func() {
74140
os.RemoveAll(tmpDir)
75141
})
@@ -97,8 +163,7 @@ func TestWriteFile(t *testing.T) {
97163
}
98164

99165
func Test_maybeUnwrap(t *testing.T) {
100-
wantErr := fmt.Errorf("the error")
101-
166+
wantErr := errors.New("the error")
102167
type args struct {
103168
err error
104169
}
@@ -113,9 +178,7 @@ func Test_maybeUnwrap(t *testing.T) {
113178
for _, tt := range tests {
114179
t.Run(tt.name, func(t *testing.T) {
115180
err := maybeUnwrap(tt.args.err)
116-
if !reflect.DeepEqual(err, tt.wantErr) { //nolint:govet // legacy deep equal error check
117-
t.Errorf("maybeUnwrap() error = %v, wantErr %v", err, tt.wantErr)
118-
}
181+
require.Equal(t, tt.wantErr, err)
119182
})
120183
}
121184
}

‎internal/utils/utfbom/LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright (c) 2018-2020, Dmitrij Koniajev ([email protected])
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

0 commit comments

Comments
 (0)