Handle zero length comment and file paths for Nostalgia compatibility

[rbdr/mobius] / hotline / flattened_file_object_test.go

diff --git a/hotline/flattened_file_object_test.go b/hotline/flattened_file_object_test.go
index 63e71757ea01c427e806e8eae3e10b7720c61b14..1d438188bb1380f1b4ec7a0e4e6f58b3b8728bc2 100644 (file)
--- a/hotline/flattened_file_object_test.go
+++ b/hotline/flattened_file_object_test.go
@@ -1,36 +1,106 @@
 package hotline
 
 import (
-       "bytes"
-       "encoding/hex"
+       "fmt"
+       "github.com/davecgh/go-spew/spew"
+       "github.com/stretchr/testify/assert"
+       "os"
        "testing"
 )
 
-func TestReadFlattenedFileObject(t *testing.T) {
-       testData, _ := hex.DecodeString("46494c500001000000000000000000000000000000000002494e464f000000000000000000000052414d414354455854747478740000000000000100000000000000000000000000000000000000000000000000000000000000000007700000ba74247307700000ba74247300000008746573742e74787400004441544100000000000000000000000474657374")
-
-       ffo := ReadFlattenedFileObject(testData)
+func TestNewFlattenedFileObject(t *testing.T) {
+       type args struct {
+               fileRoot string
+               filePath []byte
+               fileName []byte
+       }
+       tests := []struct {
+               name    string
+               args    args
+               want    *flattenedFileObject
+               wantErr assert.ErrorAssertionFunc
+       }{
+               {
+                       name: "with valid file",
+                       args: args{
+                               fileRoot: func() string { path, _ := os.Getwd(); return path + "/test/config/Files" }(),
+                               fileName: []byte("testfile.txt"),
+                               filePath: []byte{0, 0},
+                       },
+                       want: &flattenedFileObject{
+                               FlatFileHeader:                NewFlatFileHeader(),
+                               FlatFileInformationForkHeader: FlatFileInformationForkHeader{},
+                               FlatFileInformationFork:       NewFlatFileInformationFork("testfile.txt", make([]byte, 8)),
+                               FlatFileDataForkHeader: FlatFileDataForkHeader{
+                                       ForkType:        [4]byte{0x4d, 0x41, 0x43, 0x52}, // DATA
+                                       CompressionType: [4]byte{0, 0, 0, 0},
+                                       RSVD:            [4]byte{0, 0, 0, 0},
+                                       DataSize:        [4]byte{0x00, 0x00, 0x00, 0x17},
+                               },
+                               FileData: nil,
+                       },
+                       wantErr: assert.NoError,
+               },
+               {
+                       name: "when file path is invalid",
+                       args: args{
+                               fileRoot: func() string { path, _ := os.Getwd(); return path + "/test/config/Files" }(),
+                               fileName: []byte("nope.txt"),
+                       },
+                       want:    nil,
+                       wantErr: assert.Error,
+               },
+       }
+       for _, tt := range tests {
+               t.Run(tt.name, func(t *testing.T) {
+                       got, err := NewFlattenedFileObject(tt.args.fileRoot, tt.args.filePath, tt.args.fileName, 0)
+                       if tt.wantErr(t, err, fmt.Sprintf("NewFlattenedFileObject(%v, %v, %v)", tt.args.fileRoot, tt.args.filePath, tt.args.fileName)) {
+                               return
+                       }
 
-       format := ffo.FlatFileHeader.Format
-       want := []byte("FILP")
-       if !bytes.Equal(format, want) {
-               t.Errorf("ReadFlattenedFileObject() = %q, want %q", format, want)
+                       // Clear the file timestamp fields to work around problems running the tests in multiple timezones
+                       // TODO: revisit how to test this by mocking the stat calls
+                       got.FlatFileInformationFork.CreateDate = make([]byte, 8)
+                       got.FlatFileInformationFork.ModifyDate = make([]byte, 8)
+                       assert.Equalf(t, tt.want, got, "NewFlattenedFileObject(%v, %v, %v)", tt.args.fileRoot, tt.args.filePath, tt.args.fileName)
+               })
        }
 }
 
-//
-//func TestNewFlattenedFileObject(t *testing.T) {
-//     ffo := NewFlattenedFileObject("test/config/files", "testfile.txt")
-//
-//     dataSize := ffo.FlatFileDataForkHeader.DataSize
-//     want := []byte{0, 0, 0, 0x17}
-//     if bytes.Compare(dataSize, want) != 0 {
-//             t.Errorf("%q, want %q", dataSize, want)
-//     }
-//
-//     comment := ffo.FlatFileInformationFork.Comment
-//     want = []byte("Test Comment")
-//     if bytes.Compare(ffo.FlatFileInformationFork.Comment, want) != 0 {
-//             t.Errorf("%q, want %q", comment, want)
-//     }
-//}
+func TestFlatFileInformationFork_UnmarshalBinary(t *testing.T) {
+       type args struct {
+               b []byte
+       }
+       tests := []struct {
+               name    string
+               args    args
+               wantErr assert.ErrorAssertionFunc
+       }{
+               {
+                       name: "when zero length comment size is omitted (Nostalgia client behavior)",
+                       args: args{
+                               b: []byte{
+                                       0x41, 0x4d, 0x41, 0x43, 0x3f, 0x3f, 0x3f, 0x3f, 0x3f, 0x3f, 0x3f, 0x3f, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x09, 0x62, 0x65, 0x61, 0x72, 0x2e, 0x74, 0x69, 0x66, 0x66,
+                               },
+                       },
+                       wantErr: assert.NoError,
+               },
+               {
+                       name: "when zero length comment size is included",
+                       args: args{
+                               b: []byte{
+                                       0x41, 0x4d, 0x41, 0x43, 0x3f, 0x3f, 0x3f, 0x3f, 0x3f, 0x3f, 0x3f, 0x3f, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x09, 0x62, 0x65, 0x61, 0x72, 0x2e, 0x74, 0x69, 0x66, 0x66, 0x00, 0x00,
+                               },
+                       },
+                       wantErr: assert.NoError,
+               },
+       }
+       for _, tt := range tests {
+               t.Run(tt.name, func(t *testing.T) {
+                       ffif := &FlatFileInformationFork{}
+                       tt.wantErr(t, ffif.UnmarshalBinary(tt.args.b), fmt.Sprintf("UnmarshalBinary(%v)", tt.args.b))
+
+                       spew.Dump(ffif)
+               })
+       }
+}