#include "FakeFilesystem.h" #define FILESYSTEM FakeFilesystem #define private public #include "transaction_under_test.h" #undef private #include using Writer=mesh::ContactFileTransaction; using Progress=Writer::CommitProgress; using Outcome=Writer::Outcome; using Bytes=std::vector; #if defined(ESP32_PLATFORM) #define DEFER_BEGIN ,true #else #define DEFER_BEGIN #endif Bytes image(size_t n,uint8_t salt=0){Bytes out(n);for(size_t i=0;imetadata_probes;if(fs->metadata_error||fs->metadata_probes==fs->fail_metadata_probe)return false;found=fs->exists(name);return true;} void begin(Writer& w,bool coalesce=false){ #if defined(ESP32_PLATFORM) for(unsigned i=0;!w&&i<10;++i){const auto before=SPIFFS.startupOperations();assert(w.serviceBegin(coalesce)!=Writer::BeginProgress::Failed);assert(SPIFFS.startupOperations()-before<=1);} #else (void)coalesce; #endif assert(w); } void write(Writer& w,const Bytes& bytes){for(size_t i=0;i=SPIFFS.fail_metadata_probe); terminal(writer,Outcome::Indeterminate); assert(SPIFFS.renames==moved); // Unknown publication cannot blindly enter rollback. assert(SPIFFS.exists("/contacts3")== (moved!=1)); if(moved!=1)assert(SPIFFS.files.at("/contacts3")== (moved==2?next:old)); assert(SPIFFS.exists("/contacts3.bak")== (moved!=3)); assert(SPIFFS.exists("/contacts3.tmp")== (moved!=2)); final=SPIFFS.files; } assert(SPIFFS.files==final);crashSnapshots(old,next); } // Probe failures before any move remain ordinary safe failures. for(unsigned probe=1;probe<=2;++probe){ reset(old);Writer writer(&SPIFFS,"/contacts3",presence DEFER_BEGIN);begin(writer);write(writer,next);ready(writer,old); SPIFFS.fail_metadata_probe=SPIFFS.metadata_probes+probe; assert(writer.serviceCommit()==Progress::Failed);terminal(writer,Outcome::NotCommitted); assert(SPIFFS.renames==0&&SPIFFS.files.at("/contacts3")==old&&!SPIFFS.exists("/contacts3.tmp")); } } void fresh(){ const auto next=image(608,2); for(unsigned fault=0;fault<5;++fault){ SPIFFS=FakeFilesystem();FakeFilesystem::Files final; { Writer writer(&SPIFFS,"/contacts3",presence DEFER_BEGIN);begin(writer);write(writer,next);ready(writer,{},false); if(fault==1)SPIFFS.false_success_rename=1; if(fault==2)SPIFFS.late_rename_error=1; if(fault==3)SPIFFS.after_rename=[](FakeFilesystem& fs,const char*){fs.fail_metadata_probe=fs.metadata_probes+1;}; if(fault==4)SPIFFS.fail_rename=1; const Outcome expected=fault==3?Outcome::Indeterminate: fault==1||fault==4?Outcome::NotCommitted:Outcome::Committed; const auto reads=SPIFFS.reads; assert(writer.serviceCommit(true,8,true)==(expected==Outcome::Committed?Progress::Succeeded:Progress::Failed)); assert(SPIFFS.reads==reads);terminal(writer,expected); assert(SPIFFS.exists("/contacts3")== (expected!=Outcome::NotCommitted)); if(SPIFFS.exists("/contacts3"))assert(SPIFFS.files.at("/contacts3")==next); assert(!SPIFFS.exists("/contacts3.bak")&&!SPIFFS.exists("/contacts3.tmp")); final=SPIFFS.files; } assert(SPIFFS.files==final); } } void ambiguous(){ const auto old=image(304,1),next=image(608,2); for(bool deferred:{false,true})for(unsigned moved=1;moved<=2;++moved)for(bool duplicate:{false,true}){ reset(old);FakeFilesystem::Files final; { Writer writer(&SPIFFS,"/contacts3",presence DEFER_BEGIN);begin(writer);write(writer,next);ready(writer,old); SPIFFS.after_rename=[=](FakeFilesystem& fs,const char*){ if(fs.renames!=moved)return; if(moved==1){ if(duplicate)fs.files["/contacts3"]=old;else fs.files.erase("/contacts3.bak"); }else{ if(duplicate)fs.files["/contacts3.tmp"]=next;else fs.files.erase("/contacts3"); } }; const auto reads=SPIFFS.reads,removes=SPIFFS.removes; assert(writer.serviceCommit(true,8,deferred)==Progress::Failed); terminal(writer,Outcome::Indeterminate); assert(SPIFFS.renames==moved&&SPIFFS.reads==reads&&SPIFFS.removes==removes); assert(SPIFFS.exists("/contacts3")==duplicate); if(duplicate)assert(SPIFFS.files.at("/contacts3")== (moved==1?old:next)); assert(SPIFFS.exists("/contacts3.bak")== (moved==2||duplicate)); if(SPIFFS.exists("/contacts3.bak"))assert(SPIFFS.files.at("/contacts3.bak")==old); assert(SPIFFS.exists("/contacts3.tmp")== (moved==1||duplicate)); if(SPIFFS.exists("/contacts3.tmp"))assert(SPIFFS.files.at("/contacts3.tmp")==next); final=SPIFFS.files; } assert(SPIFFS.files==final); } } void recovery(){ const auto old=image(304,1),next=image(608,2); for(unsigned fault=0;fault<8;++fault){ FakeFilesystem fs;fs.files["/contacts3.bak"]=old;fs.files["/contacts3.tmp"]=next; if(fault==1)fs.false_success_rename=1; if(fault==2)fs.late_rename_error=1; if(fault==3)fs.fail_rename=1; if(fault>=4)fs.fail_metadata_probe=fault-3; // Before rename and each confirmation probe. assert(Writer::recover(&fs,"/contacts3",presence)==(fault==0||fault==2)); const bool moved=fault==0||fault==2||fault>=6; assert(fs.exists("/contacts3")==moved&&fs.exists("/contacts3.bak")==!moved); if(moved)assert(fs.files.at("/contacts3")==old); assert(fs.files.at("/contacts3.tmp")==next); fs.false_success_rename=fs.late_rename_error=fs.fail_rename=fs.fail_metadata_probe=0; assert(Writer::recover(&fs,"/contacts3",presence)&&fs.files.at("/contacts3")==old); } // A present candidate wins over the retained old backup; scratch is never promoted. {FakeFilesystem fs;fs.files["/contacts3"]=next;fs.files["/contacts3.bak"]=old; assert(Writer::recover(&fs,"/contacts3",presence)&&fs.renames==0&&fs.files.at("/contacts3")==next&&fs.files.at("/contacts3.bak")==old);} #if defined(ESP32_PLATFORM) for(bool background:{false,true})for(unsigned fault=0;fault<6;++fault){ SPIFFS=FakeFilesystem();SPIFFS.files["/contacts3.bak"]=old;SPIFFS.files["/contacts3.tmp"]=next; FakeFilesystem::Files final; { Writer writer(&SPIFFS,"/contacts3",presence,true); if(fault==1)SPIFFS.false_success_rename=1; if(fault==2)SPIFFS.late_rename_error=1; if(fault==3)SPIFFS.fail_rename=1; if(fault>=4)SPIFFS.after_rename=[=](FakeFilesystem& fs,const char*){fs.fail_metadata_probe=fs.metadata_probes+fault-3;}; auto result=Writer::BeginProgress::Pending;unsigned passes=0; while(result==Writer::BeginProgress::Pending){ const auto before=SPIFFS.startupOperations();result=writer.serviceBegin(background); assert(++passes<=10&&SPIFFS.startupOperations()-before<=1); } const bool recovered=fault==0||fault==2; assert(result==(recovered?Writer::BeginProgress::Ready:Writer::BeginProgress::Failed)); if(recovered){assert(writer&&passes==unsigned(background?10:9));assert(writer.outcome()==Outcome::Pending);} else {assert(!writer&&!writer._owns_temp);terminal(writer,Outcome::Indeterminate); assert(SPIFFS.files.at("/contacts3.tmp")==next);} final=SPIFFS.files; } if(fault==0||fault==2){final.erase("/contacts3.tmp");assert(SPIFFS.files==final&&SPIFFS.files.at("/contacts3")==old);} else assert(SPIFFS.files==final); } // Cancellation at every recovery/setup boundary retains old authority and // never deletes prior scratch until its explicit Remove stage. for(unsigned completed=0;completed<=10;++completed){ SPIFFS=FakeFilesystem();SPIFFS.files["/contacts3.bak"]=old;SPIFFS.files["/contacts3.tmp"]=next; {Writer writer(&SPIFFS,"/contacts3",presence,true); for(unsigned i=0;i=2)SPIFFS.fail_metadata_probe=fault-1; FakeFilesystem::Files final; {Writer writer(&SPIFFS,"/contacts3",presence);assert(!writer);terminal(writer,Outcome::Indeterminate); assert(SPIFFS.files.at("/contacts3.tmp")==next);final=SPIFFS.files;} assert(SPIFFS.files==final); } #endif } int main(int argc,char**argv){const std::string mode=argc>1?argv[1]:"all";if(mode=="contracts")contracts();else if(mode=="retire")retirement();else if(mode=="cancel")repeatedAndCancel();else if(mode=="faults")faultsAndCrash();else if(mode=="counts")counts();else if(mode=="outcomes")outcomes();else if(mode=="metadata")metadata();else if(mode=="fresh")fresh();else if(mode=="ambiguous")ambiguous();else if(mode=="recovery")recovery();else assert(false);}