Skip to content

Format Fw and add to CI #3976

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Aug 4, 2025
Merged

Format Fw and add to CI #3976

merged 3 commits into from
Aug 4, 2025

Conversation

@thomas-bc
Copy link
Collaborator

@thomas-bc thomas-bc commented Aug 4, 2025

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

Change Description

Towards #1984

Formatted Fw/ and added to CI

Review

I went through the code and it looks all good to me. If CI passes, should be all good to merge.

github-advanced-security[bot]
github-advanced-security bot found potential problems Aug 4, 2025
View reviewed changes
Fw/Comp/ActiveComponentBase.cpp
};

};
ActiveComponentBase::ActiveComponentBase(const char* name) : QueuedComponentBase(name) {}

Check warning

Code scanning / CppCheck

Member variable 'ActiveComponentBase::m_stage' is not initialized in the constructor. Warning

Member variable 'ActiveComponentBase::m_stage' is not initialized in the constructor.
Fw/Comp/PassiveComponentBase.hpp

protected:
PassiveComponentBase(const char* name); //!< Named constructor
virtual ~PassiveComponentBase(); //!< Destructor

Check warning

Code scanning / CppCheck

Single-parameter constructors should be marked explicit. Warning

Single-parameter constructors should be marked explicit.
Fw/Comp/QueuedComponentBase.hpp
protected:
QueuedComponentBase(const char* name); //!< Constructor
virtual ~QueuedComponentBase(); //!< Destructor
void init(FwEnumStoreType instance); //!< initialization function

Check warning

Code scanning / CppCheck

Single-parameter constructors should be marked explicit. Warning

Single-parameter constructors should be marked explicit.
Fw/Log/LogBuffer.cpp
}
LogBuffer::LogBuffer(const LogBuffer& other) : Fw::SerializeBufferBase() {
SerializeStatus stat = SerializeBufferBase::setBuff(other.m_bufferData, other.getBuffLength());
FW_ASSERT(FW_SERIALIZE_OK == stat, static_cast<FwAssertArgType>(stat));

Check warning

Code scanning / CppCheck

Member variable 'LogBuffer::m_bufferData' is not assigned in the copy constructor. Should it be copied? Warning

Member variable 'LogBuffer::m_bufferData' is not assigned in the copy constructor. Should it be copied?
Fw/Obj/ObjBase.hpp
//!
//! \param name Object name
ObjBase(const char* name);

Check warning

Code scanning / CppCheck

Single-parameter constructors should be marked explicit. Warning

Single-parameter constructors should be marked explicit.
Fw/Port/OutputPortBase.hpp
private:
// Disable constructors
OutputPortBase(OutputPortBase*);
OutputPortBase(OutputPortBase&);

Check warning

Code scanning / CppCheck

Single-parameter constructors should be marked explicit. Warning

Single-parameter constructors should be marked explicit.
Fw/Port/PortBase.hpp

};
// Disable constructors
PortBase(PortBase*);

Check warning

Code scanning / CppCheck

Single-parameter constructors should be marked explicit. Warning

Single-parameter constructors should be marked explicit.
Fw/Prm/PrmBuffer.cpp
}
ParamBuffer::ParamBuffer(const ParamBuffer& other) : Fw::SerializeBufferBase() {
SerializeStatus stat = SerializeBufferBase::setBuff(other.m_bufferData, other.getBuffLength());
FW_ASSERT(FW_SERIALIZE_OK == stat, static_cast<FwAssertArgType>(stat));

Check warning

Code scanning / CppCheck

Member variable 'ParamBuffer::m_bufferData' is not assigned in the copy constructor. Should it be copied? Warning

Member variable 'ParamBuffer::m_bufferData' is not assigned in the copy constructor. Should it be copied?
Fw/Time/TimeInterval.cpp Outdated

Check warning

Code scanning / CppCheck

Could not find a newline character at the end of the file. Warning

Could not find a newline character at the end of the file.
Fw/Tlm/TlmBuffer.cpp
}
TlmBuffer::TlmBuffer(const TlmBuffer& other) : Fw::SerializeBufferBase() {
SerializeStatus stat = SerializeBufferBase::setBuff(other.m_bufferData, other.getBuffLength());
FW_ASSERT(FW_SERIALIZE_OK == stat, static_cast<FwAssertArgType>(stat));

Check warning

Code scanning / CppCheck

Member variable 'TlmBuffer::m_bufferData' is not assigned in the copy constructor. Should it be copied? Warning

Member variable 'TlmBuffer::m_bufferData' is not assigned in the copy constructor. Should it be copied?
github-advanced-security[bot]
github-advanced-security bot found potential problems Aug 4, 2025
View reviewed changes
Copy link

@github-advanced-security github-advanced-security bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

github-advanced-security[bot]
github-advanced-security bot found potential problems Aug 4, 2025
View reviewed changes
@thomas-bc thomas-bc marked this pull request as ready for review August 4, 2025 19:31
@thomas-bc thomas-bc requested review from LeStarch and Copilot August 4, 2025 19:31
Copilot AI reviewed Aug 4, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR formats the Fw/ directory according to the project's coding standards and adds it to CI format checking. The changes are primarily formatting-related with no functional modifications to the codebase.

  • Standardized formatting across all files in the Fw/ directory
  • Added Fw/ to the CI format checking workflow
  • Applied consistent code style including header organization, spacing, and function signature formatting

Reviewed Changes

Copilot reviewed 103 out of 110 changed files in this pull request and generated no comments.

Show a summary per file
File Description
.github/workflows/format-check.yml Added Fw directory to CI format checking
Fw/Types/test/ut/TypesTest.cpp Formatting fixes: removed extra blank lines, reformatted long function calls
Fw/Types/test/ut/SnPrintfFormatTest.cpp Reordered includes to follow project conventions
Fw/Types/test/ut/SerializeBufferBaseTester.hpp Reordered includes, added proper namespace comment
Fw/Types/test/ut/ExternalSerializeBufferTest.cpp Reordered includes, added proper namespace comment
Fw/Types/test/ut/CAssertTest.cpp Reordered includes, removed extra blank lines
Fw/Types/test/ut/AssertTypesTest.cpp Reordered includes, removed extra blank lines
Fw/Types/snprintf_format.cpp Reordered includes, reformatted function signatures
Fw/Types/format.hpp Added proper namespace comment, removed extra blank lines
Fw/Types/StringUtils.hpp Reformatted function signatures, removed extra blank lines
Fw/Types/StringUtils.cpp Reordered includes
Fw/Types/StringToNumber.cpp Reordered includes, reformatted function signatures and static_asserts
Fw/Types/StringTemplate.hpp Reformatted template declaration
Fw/Types/StringBase.hpp Reordered includes
Fw/Types/Serializable.hpp Formatting fixes: removed blank lines, reformatted long lines
Fw/Types/Serializable.cpp Reformatted function definitions with proper line breaks
Fw/Types/SerialBuffer.cpp Reordered includes
Fw/Types/PolyType.cpp Reordered includes
Fw/Types/CAssert.h Reformatted macro definition
Fw/Types/BasicTypes.hpp Moved header guards to proper position
Fw/Types/BasicTypes.h Reordered includes, reformatted error message, removed extra blank lines
Fw/Types/Assert.hpp Reformatted function signatures and macros
Fw/Types/Assert.cpp Updated format strings, reformatted function signatures
Multiple files in Fw/Trap/, Fw/Tlm/, Fw/Time/, etc. Consistent formatting changes including include reordering, namespace comments, constructor/destructor formatting

@LeStarch LeStarch merged commit ab58cf1 into nasa:devel Aug 4, 2025
49 checks passed
@thomas-bc thomas-bc deleted the format-fw branch August 4, 2025 20:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@LeStarch LeStarch LeStarch approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@thomas-bc @LeStarch