reiver
/
go-raft
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

initial commits

master
Charles Iliya Krempeaux 2024-01-23 06:27:18 -08:00
parent f8e5f3fd28
commit 56a1ff56b1
2 changed files with 240 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

83
writeembbededfile.go 100644
View File

@ -0,0 +1,83 @@
package raft
import (
"io"
"strconv"
"sourcecode.social/reiver/go-erorr"
)
// writeEmbeddedFile embeds a(nother) file into a RAFT file using the provided file-name, file-size, and file-content.
//
// Note that this adds an additional "\n" after the file-content.
// Technically it isn't necessary.
// But it is added to make the resulting raft file easier to read (if a person was to try to read it).
func writeEmbeddedFile(writer io.Writer, filename string, filesize int64, filecontent io.Reader) error {
if nil == writer {
return errNilWriter
}
if nil == filecontent {
return errNilReader
}
// file name
{
var value string = filename
{
err := writeString(writer, value)
if nil != err {
return erorr.Errorf("raft: problem writing embedded-file's file-name (i.e., %q): %w", value, err)
}
}
{
err := writeString(writer, eol)
if nil != err {
return erorr.Errorf("raft: problem writing end-of-line (i.e., %q) after writing embedded-file's file-name (i.e., %q): %w", eol, value, err)
}
}
}
// file size
{
var value string = strconv.FormatInt(filesize, 10)
{
err := writeString(writer, value)
if nil != err {
return erorr.Errorf("raft: problem writing embedded-file's file-size — %q: %w", value, err)
}
}
{
err := writeString(writer, eol)
if nil != err {
return erorr.Errorf("raft: problem writing end-of-line (i.e., %q) after writing embedded-file's file-size (i.e., %q): %w", eol, value, err)
}
}
}
// file content
{
{
err := copyN(writer, filecontent, filesize)
if nil != err {
return erorr.Errorf("raft: problem writing embedded-file's file-content: %w", err)
}
}
{
var value string = eoleol // <---- Note this is a 'eoleol' rather than just a single 'eol'. This is because the 2nd 'eol' add a blank line that makes it easier for a programmer to read the file.
err := writeString(writer, value)
if nil != err {
return erorr.Errorf("raft: problem writing 2 end-of-lines (i.e., %q) after writing file-content: %w", value, err)
}
}
}
return nil
}

157
writeembbededfile_test.go 100644
View File

@ -0,0 +1,157 @@
package raft
import (
"testing"
"io/fs"
"strings"
"time"
"sourcecode.social/reiver/go-strfs"
)
func TestWriteEmbbededFile(t *testing.T) {
tests := []struct{
Name string
Content string
Expected string
}{
{
Name: "empty.txt",
Content: "",
Expected:
"empty.txt" +"\n"+
"0" +"\n"+
""+
"\n\n",
},
{
Name: "apple.txt",
Content: "APPLE",
Expected:
"apple.txt" +"\n"+
"5" +"\n"+
"APPLE"+
"\n\n",
},
{
Name: "banana.txt",
Content: "BANANA\n",
Expected:
"banana.txt" +"\n"+
"7" +"\n"+
"BANANA\n"+
"\n\n",
},
{
Name: "cherry.txt",
Content: "CHERRY\n\n",
Expected:
"cherry.txt" +"\n"+
"8" +"\n"+
"CHERRY\n\n"+
"\n\n",
},
{
Name: "README.md",
Content: "Hello world!",
Expected:
"README.md" +"\n"+
"12" +"\n"+
"Hello world!"+
"\n\n",
},
{
Name: "SOMETHING.md",
Content:
"# Title" +"\n"+
"" +"\n"+
"Hello!" +"\n"+
"" +"\n",
Expected:
"SOMETHING.md" +"\n"+
"17" +"\n"+
"# Title" +"\n"+
"" +"\n"+
"Hello!" +"\n"+
"" +"\n"+
"\n\n",
},
{
Name: "article.txt",
Content:
"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Interdum velit laoreet id donec ultrices tincidunt arcu non sodales. Cras semper auctor neque vitae tempus quam pellentesque nec nam. Cursus turpis massa tincidunt dui ut. Diam vel quam elementum pulvinar etiam non quam. Gravida neque convallis a cras semper. Ornare massa eget egestas purus. Tempor id eu nisl nunc mi ipsum faucibus vitae aliquet. Fames ac turpis egestas maecenas pharetra. Arcu bibendum at varius vel pharetra vel turpis nunc. Integer quis auctor elit sed vulputate mi. Eget velit aliquet sagittis id consectetur purus ut faucibus. Sapien pellentesque habitant morbi tristique senectus."+
"\n"+
"\n"+
"Lorem mollis aliquam ut porttitor leo a diam sollicitudin tempor. Quis commodo odio aenean sed adipiscing. Commodo quis imperdiet massa tincidunt nunc. Quam quisque id diam vel quam elementum pulvinar etiam non. Elit ut aliquam purus sit amet luctus venenatis lectus. Sit amet mauris commodo quis. Placerat vestibulum lectus mauris ultrices eros in. Tristique sollicitudin nibh sit amet commodo nulla facilisi nullam vehicula. Augue interdum velit euismod in. Tellus pellentesque eu tincidunt tortor. Commodo viverra maecenas accumsan lacus vel facilisis. Venenatis a condimentum vitae sapien pellentesque habitant morbi. Et ligula ullamcorper malesuada proin libero nunc consequat interdum varius. Tellus integer feugiat scelerisque varius. Bibendum enim facilisis gravida neque convallis. Nisl nisi scelerisque eu ultrices vitae auctor eu."+
"\n",
Expected:
"article.txt" +"\n"+
"1573" +"\n"+
"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Interdum velit laoreet id donec ultrices tincidunt arcu non sodales. Cras semper auctor neque vitae tempus quam pellentesque nec nam. Cursus turpis massa tincidunt dui ut. Diam vel quam elementum pulvinar etiam non quam. Gravida neque convallis a cras semper. Ornare massa eget egestas purus. Tempor id eu nisl nunc mi ipsum faucibus vitae aliquet. Fames ac turpis egestas maecenas pharetra. Arcu bibendum at varius vel pharetra vel turpis nunc. Integer quis auctor elit sed vulputate mi. Eget velit aliquet sagittis id consectetur purus ut faucibus. Sapien pellentesque habitant morbi tristique senectus."+
"\n"+
"\n"+
"Lorem mollis aliquam ut porttitor leo a diam sollicitudin tempor. Quis commodo odio aenean sed adipiscing. Commodo quis imperdiet massa tincidunt nunc. Quam quisque id diam vel quam elementum pulvinar etiam non. Elit ut aliquam purus sit amet luctus venenatis lectus. Sit amet mauris commodo quis. Placerat vestibulum lectus mauris ultrices eros in. Tristique sollicitudin nibh sit amet commodo nulla facilisi nullam vehicula. Augue interdum velit euismod in. Tellus pellentesque eu tincidunt tortor. Commodo viverra maecenas accumsan lacus vel facilisis. Venenatis a condimentum vitae sapien pellentesque habitant morbi. Et ligula ullamcorper malesuada proin libero nunc consequat interdum varius. Tellus integer feugiat scelerisque varius. Bibendum enim facilisis gravida neque convallis. Nisl nisi scelerisque eu ultrices vitae auctor eu."+
"\n"+
"\n\n",
},
}
for testNumber, test := range tests {
var file fs.File
{
var content = strfs.CreateContent(test.Content)
var regularfile = strfs.RegularFile{
FileContent: content,
FileName: test.Name,
FileModTime: time.Date(2022, 12, 12, 10, 30, 14, 2, time.UTC),
}
file = &regularfile
}
var buffer strings.Builder
err := writeEmbeddedFile(&buffer, test.Name, int64(len(test.Content)), file)
if nil != err {
t.Errorf("For test #%d, did not expect an error but actually got one.", testNumber)
t.Logf("ERROR: %s", err)
t.Logf("FILE-NAME: %q", test.Name)
t.Logf("FILE-CONTENT: %q", test.Content)
t.Logf("EXPECTED-EMBEDDED-FILE:\n%q", test.Expected)
t.Logf("EXPECTED-EMBEDDED-FILE:\n%s", test.Expected)
continue
}
{
actual := buffer.String()
expected := test.Expected
if expected != actual {
t.Errorf("For test #%d, the actual written embedded file it not what was expected.", testNumber)
t.Logf("EXPECTED: %q", expected)
t.Logf("ACTUAL: %q", actual)
t.Logf("FILE-CONTENT: %q", test.Content)
t.Logf("FILE-NAME: %q", test.Name)
t.Logf("EXPECTED:\n%s", expected)
t.Logf("ACTUAL:\n%s", actual)
continue
}
}
}
}