-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #79 from planetlabs/command-io
Optionally use stdin and stdout for validate, describe, and convert commands
- Loading branch information
Showing
14 changed files
with
486 additions
and
117 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
package command | ||
|
||
import "io" | ||
|
||
var CLI struct { | ||
Convert ConvertCmd `cmd:"" help:"Convert data from one format to another."` | ||
Validate ValidateCmd `cmd:"" help:"Validate a GeoParquet file."` | ||
Describe DescribeCmd `cmd:"" help:"Describe a GeoParquet file."` | ||
Version VersionCmd `cmd:"" help:"Print the version of this program."` | ||
} | ||
|
||
type ReaderAtSeeker interface { | ||
io.Reader | ||
io.ReaderAt | ||
io.Seeker | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
package command_test | ||
|
||
import ( | ||
"io" | ||
"os" | ||
"testing" | ||
|
||
"github.com/stretchr/testify/suite" | ||
) | ||
|
||
type Suite struct { | ||
suite.Suite | ||
originalStdin *os.File | ||
mockStdin *os.File | ||
originalStdout *os.File | ||
mockStdout *os.File | ||
} | ||
|
||
func (s *Suite) SetupTest() { | ||
stdin, err := os.CreateTemp("", "stdin") | ||
s.Require().NoError(err) | ||
s.originalStdin = os.Stdin | ||
s.mockStdin = stdin | ||
os.Stdin = stdin | ||
|
||
stdout, err := os.CreateTemp("", "stdout") | ||
s.Require().NoError(err) | ||
s.originalStdout = os.Stdout | ||
s.mockStdout = stdout | ||
os.Stdout = stdout | ||
} | ||
|
||
func (s *Suite) writeStdin(data []byte) { | ||
_, writeErr := s.mockStdin.Write(data) | ||
s.Require().NoError(writeErr) | ||
_, seekErr := s.mockStdin.Seek(0, 0) | ||
s.Require().NoError(seekErr) | ||
} | ||
|
||
func (s *Suite) readStdout() []byte { | ||
if _, seekErr := s.mockStdout.Seek(0, 0); seekErr != nil { | ||
// assume the file is closed | ||
stdout, err := os.Open(s.mockStdout.Name()) | ||
s.Require().NoError(err) | ||
s.mockStdout = stdout | ||
} | ||
data, err := io.ReadAll(s.mockStdout) | ||
s.Require().NoError(err) | ||
return data | ||
} | ||
|
||
func (s *Suite) TearDownTest() { | ||
os.Stdout = s.originalStdout | ||
os.Stdin = s.originalStdin | ||
|
||
_ = s.mockStdin.Close() | ||
s.NoError(os.Remove(s.mockStdin.Name())) | ||
|
||
_ = s.mockStdout.Close() | ||
s.NoError(os.Remove(s.mockStdout.Name())) | ||
} | ||
|
||
func TestSuite(t *testing.T) { | ||
suite.Run(t, &Suite{}) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,122 @@ | ||
package command_test | ||
|
||
import ( | ||
"bytes" | ||
"encoding/json" | ||
|
||
"github.com/apache/arrow/go/v14/parquet/file" | ||
"github.com/planetlabs/gpq/cmd/gpq/command" | ||
"github.com/planetlabs/gpq/internal/geo" | ||
"github.com/planetlabs/gpq/internal/test" | ||
) | ||
|
||
func (s *Suite) TestConvertGeoParquetToGeoJSONStdout() { | ||
cmd := &command.ConvertCmd{ | ||
From: "auto", | ||
Input: "../../../internal/testdata/cases/example-v1.0.0.parquet", | ||
To: "geojson", | ||
} | ||
|
||
s.Require().NoError(cmd.Run()) | ||
data := s.readStdout() | ||
|
||
collection := &geo.FeatureCollection{} | ||
s.Require().NoError(json.Unmarshal(data, collection)) | ||
s.Len(collection.Features, 5) | ||
} | ||
|
||
func (s *Suite) TestConvertGeoJSONToGeoParquetStdout() { | ||
cmd := &command.ConvertCmd{ | ||
From: "auto", | ||
Input: "../../../internal/geojson/testdata/example.geojson", | ||
To: "parquet", | ||
} | ||
|
||
s.Require().NoError(cmd.Run()) | ||
data := s.readStdout() | ||
|
||
fileReader, err := file.NewParquetReader(bytes.NewReader(data)) | ||
s.Require().NoError(err) | ||
defer fileReader.Close() | ||
|
||
s.Equal(int64(5), fileReader.NumRows()) | ||
} | ||
|
||
func (s *Suite) TestConvertGeoParquetToUnknownStdout() { | ||
cmd := &command.ConvertCmd{ | ||
From: "auto", | ||
Input: "../../../internal/testdata/cases/example-v1.0.0.parquet", | ||
} | ||
|
||
s.ErrorContains(cmd.Run(), "when writing to stdout, the --to option must be provided") | ||
} | ||
|
||
func (s *Suite) TestConvertGeoJSONStdinToGeoParquetStdout() { | ||
s.writeStdin([]byte(`{ | ||
"type": "FeatureCollection", | ||
"features": [ | ||
{ | ||
"type": "Feature", | ||
"properties": { | ||
"name": "Null Island" | ||
}, | ||
"geometry": { | ||
"type": "Point", | ||
"coordinates": [0, 0] | ||
} | ||
} | ||
] | ||
}`)) | ||
|
||
cmd := &command.ConvertCmd{ | ||
From: "geojson", | ||
To: "geoparquet", | ||
} | ||
|
||
s.Require().NoError(cmd.Run()) | ||
data := s.readStdout() | ||
|
||
fileReader, err := file.NewParquetReader(bytes.NewReader(data)) | ||
s.Require().NoError(err) | ||
defer fileReader.Close() | ||
|
||
s.Equal(int64(1), fileReader.NumRows()) | ||
} | ||
|
||
func (s *Suite) TestConvertGeoParquetStdinToGeoJSONStdout() { | ||
s.writeStdin(test.GeoParquetFromJSON(s.T(), `{ | ||
"type": "FeatureCollection", | ||
"features": [ | ||
{ | ||
"type": "Feature", | ||
"properties": { | ||
"name": "Null Island" | ||
}, | ||
"geometry": { | ||
"type": "Point", | ||
"coordinates": [0, 0] | ||
} | ||
} | ||
] | ||
}`)) | ||
|
||
cmd := &command.ConvertCmd{ | ||
From: "geoparquet", | ||
To: "geojson", | ||
} | ||
|
||
s.Require().NoError(cmd.Run()) | ||
data := s.readStdout() | ||
|
||
collection := &geo.FeatureCollection{} | ||
s.Require().NoError(json.Unmarshal(data, collection)) | ||
s.Len(collection.Features, 1) | ||
} | ||
|
||
func (s *Suite) TestConvertUnknownStdinToGeoParquetStdout() { | ||
cmd := &command.ConvertCmd{ | ||
To: "geoparquet", | ||
} | ||
|
||
s.ErrorContains(cmd.Run(), "when reading from stdin, the --from option must be provided") | ||
} |
Oops, something went wrong.