Refactor Os::FileSystem and Os::Directory #2871

thomas-bc · 2024-09-13T16:11:25Z


*Related Issue(s)*	#2687
*Has Unit Tests (y/n)*	y
*Documentation Included (y/n)*	n

Change Description

Refactoring Os::FileSystem and Os::Directory to the new OSAL pattern

Rationale

See #2687

Future Work

Document the entire OSAL

…ctory

…dd RandomizedTesting

Os/Directory.cpp

Os/Posix/Directory.cpp

Os/test/ut/filesystem/RulesHeaders.hpp

github-advanced-security

CodeQL found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.

Os/Directory.cpp

+}
+
+
+Directory::Status Directory::readDirectory(Fw::String filenameArray[], const FwSizeType filenameArraySize, FwSizeType& filenameCount) {


Os/Directory.hpp

-            bool isOpen(); //!< check if file descriptor is open or not.
-            Status rewind(); //!<  rewind directory stream to the beginning
+    //! \brief default constructor
+    DirectoryInterface() = default;


Os/FileSystem.cpp

Os/Posix/Directory.cpp

Os/Posix/Directory.hpp

+namespace Posix {
+namespace Directory {
+
+struct PosixDirectoryHandle : public DirectoryHandle {


Os/Posix/FileSystem.cpp

+    return status;
+}
+
+PosixFileSystem::Status PosixFileSystem::_getFreeSpace(const char* path, FwSizeType& totalBytes, FwSizeType& freeBytes) {


Os/Posix/error.cpp

@@ -48,6 +48,75 @@
    return status;
 }

+FileSystem::Status errno_to_filesystem_status(PlatformIntType errno_input) {


Os/Posix/error.cpp

+    return status;
+}
+
+Directory::Status errno_to_directory_status(PlatformIntType errno_input) {


Os/FileSystem.cpp

+    return fs_status;
+} // end appendFile
+
+FileSystem::Status FileSystem::moveFile(const char* source, const char* destination) {


Os/FileSystem.cpp

+    return status;
+} // end handleFileError
+
+FileSystem::Status FileSystem::handleDirectoryError(Directory::Status dirStatus) {


Os/FileSystem.cpp

Os/Directory.cpp

+}
+
+
+Directory::Status Directory::readDirectory(Fw::String filenameArray[], const FwSizeType filenameArraySize, FwSizeType& filenameCount) {


…and clean up comments

Os/Directory.cpp

+    FwSizeType count = 0;
+    char unusedBuffer[1]; // buffer must have size but is unused
+    Status readStatus = Status::OP_OK;
+    fileCount = 0;


Os/Directory.cpp

+    Status readStatus = Status::OP_OK;
+    Status returnStatus = Status::OP_OK;
+    FwSizeType index;
+    filenameCount = 0;


Os/FileSystem.cpp

+FileSystem::Status FileSystem::_getFreeSpace(const char* path, FwSizeType& totalBytes, FwSizeType& freeBytes) {
+    FW_ASSERT(&this->m_delegate == reinterpret_cast<FileSystemInterface*>(&this->m_handle_storage[0]));
+    FW_ASSERT(path != nullptr);
+    return this->m_delegate._getFreeSpace(path, totalBytes, freeBytes);


Os/Posix/FileSystem.cpp

+        total_blocks > (std::numeric_limits<FwSizeType>::max() / block_size)) {
+        return OVERFLOW_ERROR;
+    }
+    freeBytes = free_blocks * block_size;


Os/Posix/FileSystem.cpp

+        return OVERFLOW_ERROR;
+    }
+    freeBytes = free_blocks * block_size;
+    totalBytes = total_blocks * block_size;


Os/Posix/error.cpp

@@ -48,6 +48,86 @@
    return status;
 }

+FileSystem::Status errno_to_filesystem_status(PlatformIntType errno_input) {
+    FileSystem::Status status = FileSystem::Status::OP_OK;
+    switch (errno_input) {


Os/Posix/error.cpp

+
+Directory::Status errno_to_directory_status(PlatformIntType errno_input) {
+    Directory::Status status = Directory::Status::OP_OK;
+    switch (errno_input) {


Svc/DpCatalog/DpCatalog.cpp

Os/Directory.cpp

Os/FileSystem.cpp

+// Additional functions built on top of OS-specific operations
+// ------------------------------------------------------------
+
+FileSystem::Status FileSystem::createDirectory(const char* path, bool errorIfAlreadyExists) {


Os/FileSystem.cpp

+    return status;
+}
+
+FileSystem::Status FileSystem::touch(const char* path) {


Os/FileSystem.cpp

+    return status;
+}
+
+FileSystem::PathType FileSystem::getPathType(const char* path) {


Os/FileSystem.cpp

+    return FileSystem::getPathType(path) != PathType::NOT_EXIST;
+} // end exists
+
+FileSystem::Status FileSystem::copyFile(const char* sourcePath, const char* destPath) {


Os/Posix/Directory.cpp

+    return status;
+}
+
+PosixDirectory::Status PosixDirectory::read(char* fileNameBuffer, FwSizeType bufSize) {


Os/CMakeLists.txt

Os/Posix/DefaultDirectory.cpp

Svc/FileManager/FileManager.cpp

config/FpConfig.h

thomas-bc · 2024-09-27T01:09:29Z

@LeStarch comments addressed and follow-up issues created.
I'm ready to merge this when you are!

thomas-bc added 19 commits August 16, 2024 09:47

Add FileSystem Interface

bf11671

Add OS::FileSystem interface and implementations

c70ced0

static interface + global Os::init()

eea790f

Add test harness

34c9f38

Implement Os::Directory interfaces and use it in FileSystem::readDire…

2cdca89

…ctory

Add Stub tests for Directory and FileSystem

e1bce3c

wip: modify the interface from Michael feedback

12a655a

wip: move functions around and rework interface a little more

8e11926

Add Directory rule-based tests

8b6899a

Refactored Directory for open-create + WIP: FileSystem tests

af0223a

Update state tracking mechanism in FileSystem test implementation + a…

645a771

…dd RandomizedTesting

Replace bounded while-loop with for-loop

8f2c5ba

Code cleanup

e7e8383

fix typo

d89a27f

Rename FileTracker and code reorganization / clarification

a25d748

Code style and add CWD rule

96894f1

Clean up tester code

709b4ff

More cleanup

1b4afc0

Add Posix tests to Os_ut_exe

5f9da79

thomas-bc linked an issue Sep 13, 2024 that may be closed by this pull request

OSAL Refactor: Os::FileSystem and Os::Directory #2687

Closed

github-advanced-security bot found potential problems Sep 13, 2024

View reviewed changes

Os/Directory.cpp Fixed Show fixed Hide fixed

Os/Posix/Directory.cpp Fixed Show fixed Hide fixed

Os/test/ut/filesystem/RulesHeaders.hpp Fixed Show fixed Hide fixed

Os/test/ut/filesystem/RulesHeaders.hpp Fixed Show fixed Hide fixed

thomas-bc added 2 commits September 13, 2024 09:26

Fix DpCatalog readDirectory usage

7ae9db4

Appease CI checks

dd29323

github-advanced-security bot found potential problems Sep 13, 2024

View reviewed changes

Spelling and CI warnings

3929031

github-advanced-security bot found potential problems Sep 13, 2024

View reviewed changes

Spelling + removing FppConstants include

930aa97

thomas-bc mentioned this pull request Sep 13, 2024

Svc::FileManager MoveFile command does not work across partitions #303

Closed

thomas-bc linked an issue Sep 13, 2024 that may be closed by this pull request

Svc::FileManager MoveFile command does not work across partitions #303

Closed

Add review changes and todos

a0aba85

nasa deleted a comment Sep 17, 2024

thomas-bc added 2 commits September 17, 2024 15:34

Rework moveFile into rename/copy-remove

815a27a

Add majestic comments

7f54573

github-advanced-security bot found potential problems Sep 17, 2024

View reviewed changes

thomas-bc added 4 commits September 17, 2024 17:28

Add option to error if dir exist in Fs::createDirectory

d2c2e59

spelling

32be989

include <algorithm> for std::find in tests

eef6499

Fix leftover ::CREATE modes in comments and stub tests

2518010

github-advanced-security bot found potential problems Sep 18, 2024

View reviewed changes

Os/FileSystem.cpp Fixed Show fixed Hide fixed

thomas-bc and others added 2 commits September 17, 2024 18:04

Fix CmdSequencer test case

f202ec4

Fix memory leak in testing by conditioning the Open rule

ac14b33

github-advanced-security bot found potential problems Sep 18, 2024

View reviewed changes

thomas-bc added 3 commits September 18, 2024 11:39

Fix FileManager tests

d62b5d6

Add Directory and FileSystem FPP type definitions; update CMakeLists …

c8eed05

…and clean up comments

spelling

f83d57f

thomas-bc requested a review from LeStarch September 19, 2024 15:54

thomas-bc added 5 commits September 19, 2024 15:00

Reoder header guards

6aa7b75

Implement changes from peer-review

6301a45

read into StringBase with const_cast

fe1efa9

Fix resetSer() call

96cda71

Fix spelling

6da1d39

github-advanced-security bot found potential problems Sep 26, 2024

View reviewed changes

fix spelling again i guess

63f9955

github-advanced-security bot found potential problems Sep 26, 2024

View reviewed changes

LeStarch reviewed Sep 27, 2024

View reviewed changes

Os/CMakeLists.txt Show resolved Hide resolved

LeStarch reviewed Sep 27, 2024

View reviewed changes

Os/Posix/DefaultDirectory.cpp Show resolved Hide resolved

Svc/FileManager/FileManager.cpp Show resolved Hide resolved

config/FpConfig.h Show resolved Hide resolved

Fix DpCatalog unchecked return value

9c348b3

LeStarch approved these changes Sep 27, 2024

View reviewed changes

LeStarch merged commit d6ebdff into nasa:devel Sep 27, 2024
34 of 35 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor Os::FileSystem and Os::Directory #2871

Refactor Os::FileSystem and Os::Directory #2871

thomas-bc commented Sep 13, 2024

github-advanced-security bot left a comment

thomas-bc commented Sep 27, 2024

		}


		Directory::Status Directory::readDirectory(Fw::String filenameArray[], const FwSizeType filenameArraySize, FwSizeType& filenameCount) {

Refactor Os::FileSystem and Os::Directory #2871

Refactor Os::FileSystem and Os::Directory #2871

Conversation

thomas-bc commented Sep 13, 2024

Change Description

Rationale

Future Work

github-advanced-security bot left a comment

Choose a reason for hiding this comment

thomas-bc commented Sep 27, 2024