Code updates to include more header info

Author: rjtokenring

cli/ota/decode.go

@@ -33,7 +33,7 @@ type decodeHeaderFlags struct {
 func initDecodeHeaderCommand() *cobra.Command {
 	flags := &decodeHeaderFlags{}
 	uploadCommand := &cobra.Command{
-		Use:   "decode",
+		Use:   "header-decode",
 		Short: "OTA firmware header decoder",
 		Long:  "decode OTA firmware header of the given binary file",
 		Run: func(cmd *cobra.Command, args []string) {

cli/ota/encode.go

@@ -35,7 +35,7 @@ type encodeBinaryFlags struct {
 func initEncodeBinaryCommand() *cobra.Command {
 	flags := &encodeBinaryFlags{}
 	uploadCommand := &cobra.Command{
-		Use:   "encode",
+		Use:   "header-encode",
 		Short: "OTA firmware encoder",
 		Long:  "encode header firmware to make it compatible with Arduino OTA",
 		Run: func(cmd *cobra.Command, args []string) {

command/ota/encode.go

@@ -38,7 +38,7 @@ func Encode(params *EncodeParams) (*string, error) {
 	}
 
 	// Verify if file has already an OTA header
-	header, _ := ota.DecodeOtaFirmwareHeader(params.File)
+	header, _ := ota.DecodeOtaFirmwareHeaderFromFile(params.File)
 	if header != nil {
 		return nil, fmt.Errorf("file %s contains a valid OTA header. Skip header encoding", params.File)
 	}

command/ota/generate.go

@@ -26,7 +26,6 @@ import (
 	inota "github.com/arduino/arduino-cloud-cli/internal/ota"
 )
 
-
 // Generate takes a .bin file and generates a .ota file.
 func Generate(binFile string, outFile string, fqbn string) error {
 

command/ota/massupload.go

@@ -67,7 +67,7 @@ func MassUpload(ctx context.Context, params *MassUploadParams, cred *config.Cred
 
 	if !params.DoNotApplyHeader {
 		//Verify if file has already an OTA header
-		header, _ := ota.DecodeOtaFirmwareHeader(params.File)
+		header, _ := ota.DecodeOtaFirmwareHeaderFromFile(params.File)
 		if header != nil {
 			params.DoNotApplyHeader = true
 		}

command/ota/readheader.go

@@ -47,7 +47,7 @@ func ReadHeader(params *ReadHeaderParams) error {
 	}
 
 	// Verify if file has already an OTA header
-	header, err := ota.DecodeOtaFirmwareHeader(params.File)
+	header, err := ota.DecodeOtaFirmwareHeaderFromFile(params.File)
 	if err != nil {
 		return fmt.Errorf("file %s does not contains a valid OTA header: %v", params.File, err)
 	}

command/ota/upload.go

@@ -64,7 +64,7 @@ func Upload(ctx context.Context, params *UploadParams, cred *config.Credentials)
 
 	if !params.DoNotApplyHeader {
 		//Verify if file has already an OTA header
-		header, _ := ota.DecodeOtaFirmwareHeader(params.File)
+		header, _ := ota.DecodeOtaFirmwareHeaderFromFile(params.File)
 		if header != nil {
 			params.DoNotApplyHeader = true
 		}

coverage_unit.txt

@@ -43,6 +43,7 @@ require (
 	github.com/golang/protobuf v1.5.3 // indirect
 	github.com/h2non/filetype v1.1.3 // indirect
 	github.com/hashicorp/hcl v1.0.0 // indirect
+	github.com/icza/bitio v1.1.0 // indirect
 	github.com/inconshreveable/mousetrap v1.0.0 // indirect
 	github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect
 	github.com/josharian/intern v1.0.0 // indirect

go.mod

@@ -285,6 +285,9 @@ github.com/howeyc/crc16 v0.0.0-20171223171357-2b2a61e366a6/go.mod h1:JslaLRrzGsO
 github.com/iancoleman/strcase v0.2.0/go.mod h1:iwCmte+B7n89clKwxIoIXy/HfoL7AsD47ZCWhYzw7ho=
 github.com/ianlancetaylor/demangle v0.0.0-20181102032728-5e5cf60278f6/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc=
 github.com/ianlancetaylor/demangle v0.0.0-20200824232613-28f6c0f3b639/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc=
+github.com/icza/bitio v1.1.0 h1:ysX4vtldjdi3Ygai5m1cWy4oLkhWTAi+SyO6HC8L9T0=
+github.com/icza/bitio v1.1.0/go.mod h1:0jGnlLAx8MKMr9VGnn/4YrvZiprkvBelsVIbA9Jjr9A=
+github.com/icza/mighty v0.0.0-20180919140131-cfd07d671de6/go.mod h1:xQig96I1VNBDIWGCdTt54nHt6EeI639SmHycLYL7FkA=
 github.com/inconshreveable/mousetrap v1.0.0 h1:Z8tu5sraLXCXIcARxBp/8cbvlwVa7Z1NHg9XEKhtSvM=
 github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
 github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A=

go.sum

@@ -0,0 +1,61 @@
+// This code is a go port of LZSS encoder-decoder (Haruhiko Okumura; public domain)
+
+package lzss
+
+import (
+	"bytes"
+
+	"github.com/icza/bitio"
+)
+
+func Decompress(data []byte) []byte {
+	input := bitio.NewReader(bytes.NewBuffer(data))
+	output := make([]byte, 0)
+
+	buffer := make([]byte, bufsz*2)
+	for i := 0; i < bufsz-looksz; i++ {
+		buffer[i] = ' '
+	}
+
+	r := bufsz - looksz
+	var char byte
+	var isChar bool
+	var err error
+	for {
+		isChar, err = input.ReadBool()
+		if err != nil {
+			break
+		}
+
+		if isChar {
+			char, err = input.ReadByte()
+			if err != nil {
+				break
+			}
+			output = append(output, char)
+			buffer[r] = char
+			r++
+			r &= bufsz - 1
+		} else {
+			var i, j uint64
+			i, err = input.ReadBits(idxsz)
+			if err != nil {
+				break
+			}
+			j, err = input.ReadBits(lensz)
+			if err != nil {
+				break
+			}
+
+			for k := 0; k <= int(j)+1; k++ {
+				char = buffer[(int(i)+k)&(bufsz-1)]
+				output = append(output, char)
+				buffer[r] = char
+				r++
+				r &= bufsz - 1
+			}
+		}
+	}
+
+	return output
+}

internal/lzss/decoder.go

@@ -0,0 +1,50 @@
+package lzss
+
+import (
+	"bytes"
+	"os"
+	"testing"
+)
+
+func TestDecode(t *testing.T) {
+	tests := []struct {
+		name    string
+		infile  string
+		outfile string
+	}{
+		{
+			name:    "blink",
+			infile:  "testdata/blink.lzss",
+			outfile: "testdata/blink.bin",
+		},
+		{
+			name:    "cloud sketch",
+			infile:  "testdata/cloud.lzss",
+			outfile: "testdata/cloud.bin",
+		},
+		{
+			name:    "empty binary",
+			infile:  "testdata/empty.lzss",
+			outfile: "testdata/empty.bin",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			input, err := os.ReadFile(tt.infile)
+			if err != nil {
+				t.Fatal("couldn't open test file")
+			}
+
+			want, err := os.ReadFile(tt.outfile)
+			if err != nil {
+				t.Fatal("couldn't open test file")
+			}
+
+			got := Decompress(input)
+			if !bytes.Equal(want, got) {
+				t.Error("decoding failed", want, got)
+			}
+		})
+	}
+}