Skip to content
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.

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

Fix #210, Fix #211, bring sample_app fully into compliance #212

Merged
merged 2 commits into from
Nov 14, 2023

Conversation

jphickey
Copy link
Contributor

@jphickey jphickey commented Nov 1, 2023

Describe the contribution
This is another multi-part PR to bring sample_app up to date - combined due to dependencies:

Part 1: rename symbols, and split unit tests - should bring everything into full compliance with recommended patterns
Fixes #210

Part 2: adds a "DisplayValue" command. This command is needed to demonstrate how to use parameters on a command, as none of the existing commands used parameters.
Fixes #211

Testing performed
Build and run all tests

Expected behavior changes
New command to Display Parameters, via command code 3.

System(s) tested on
Debian

Contributor Info - All information REQUIRED for consideration of pull request
Joseph Hickey, Vantage Systems, Inc.

Update internal symbol naming to better follow conventions.  Notably,
this renames the "SampleAppTable" to be "ExampleTable", among other
things.

This also adds a separate dispatch source file, splits the unit test
into source file units as well.
The display param command shows an example of how to pass in and use a
parameter with a command.  3 types are illustrated; a signed and
unsigned int, and a string.
@@ -73,23 +109,25 @@
/* This function Process Ground Station Command */
/* */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
int32 SAMPLE_APP_Process(const SAMPLE_APP_ProcessCmd_t *Msg)
CFE_Status_t SAMPLE_APP_ProcessCmd(const SAMPLE_APP_ProcessCmd_t *Msg)

Check notice

Code scanning / CodeQL-coding-standard

Long function without assertion Note

All functions of more than 10 lines should have at least one assertion.
/* telemetry, packetize it and send it to the housekeeping task via */
/* the software bus */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
CFE_Status_t SAMPLE_APP_SendHkCmd(const SAMPLE_APP_SendHkCmd_t *Msg)

Check notice

Code scanning / CodeQL-coding-standard

Long function without assertion Note

All functions of more than 10 lines should have at least one assertion.
/* command pipe. */
/* */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
void SAMPLE_APP_TaskPipe(const CFE_SB_Buffer_t *SBBufPtr)

Check notice

Code scanning / CodeQL-coding-standard

Long function without assertion Note

All functions of more than 10 lines should have at least one assertion.
/* SAMPLE ground commands */
/* */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * **/
void SAMPLE_APP_ProcessGroundCommand(const CFE_SB_Buffer_t *SBBufPtr)

Check notice

Code scanning / CodeQL-coding-standard

Long function without assertion Note

All functions of more than 10 lines should have at least one assertion.
/* Verify command packet length */
/* */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * **/
bool SAMPLE_APP_VerifyCmdLength(const CFE_MSG_Message_t *MsgPtr, size_t ExpectedLength)

Check notice

Code scanning / CodeQL-coding-standard

Long function without assertion Note

All functions of more than 10 lines should have at least one assertion.
@jphickey jphickey added the CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) label Nov 2, 2023
@dzbaker dzbaker added CCB:Approved Indicates code approval by CCB and removed CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) labels Nov 2, 2023
dzbaker added a commit to nasa/cFS that referenced this pull request Nov 13, 2023
*Combines:*

sch_lab v2.5.0-rc4+dev71
sample_app v1.3.0-rc4+dev65
to_lab v2.5.0-rc4+dev66
ci_lab v2.5.0-rc4+dev69
cFE v7.0.0-rc4+dev411
PSP v1.6.0-rc4+dev96

**Includes:**

*sch_lab*
- nasa/sch_lab#129
- nasa/sch_lab#149
- nasa/sch_lab#142
- nasa/sch_lab#134

*sample_app*
- nasa/sample_app#212
- nasa/sample_app#187
- nasa/sample_app#190

*to_lab*
- nasa/to_lab#168
- nasa/to_lab#134
- nasa/to_lab#146
- nasa/to_lab#148
- nasa/to_lab#152
- nasa/to_lab#158
- nasa/to_lab#163

*ci_lab*
- nasa/ci_lab#152
- nasa/ci_lab#153

*cFE*
- nasa/cFE#2462
- nasa/cFE#2408

*PSP*
- nasa/PSP#417

Co-authored by: Avi Weiss <thnkslprpt@users.noreply.github.com>
Co-authored by: Joseph Hickey <jphickey@users.noreply.github.com>
Co-authored by: Isaac Rowe <irowebbn@users.noreply.github.com>
Co-authored by: Jacob Hageman  <skliper@users.noreply.github.com>
@dzbaker dzbaker mentioned this pull request Nov 13, 2023
2 tasks
@dzbaker dzbaker merged commit 091a962 into nasa:main Nov 14, 2023
11 checks passed
dzbaker added a commit to nasa/cFS that referenced this pull request Nov 14, 2023
*Combines:*

sch_lab v2.5.0-rc4+dev71
sample_app v1.3.0-rc4+dev65
to_lab v2.5.0-rc4+dev66
ci_lab v2.5.0-rc4+dev69
cFE v7.0.0-rc4+dev411
PSP v1.6.0-rc4+dev96

**Includes:**

*sch_lab*
- nasa/sch_lab#129
- nasa/sch_lab#149
- nasa/sch_lab#142
- nasa/sch_lab#134

*sample_app*
- nasa/sample_app#212
- nasa/sample_app#187
- nasa/sample_app#190

*to_lab*
- nasa/to_lab#168
- nasa/to_lab#134
- nasa/to_lab#146
- nasa/to_lab#148
- nasa/to_lab#152
- nasa/to_lab#158
- nasa/to_lab#163

*ci_lab*
- nasa/ci_lab#152
- nasa/ci_lab#153

*cFE*
- nasa/cFE#2462
- nasa/cFE#2408

*PSP*
- nasa/PSP#417

Co-authored by: Avi Weiss <thnkslprpt@users.noreply.github.com>
Co-authored by: Joseph Hickey <jphickey@users.noreply.github.com>
Co-authored by: Isaac Rowe <irowebbn@users.noreply.github.com>
Co-authored by: Jacob Hageman  <skliper@users.noreply.github.com>
@jphickey jphickey deleted the fix-210-211 branch November 16, 2023 14:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CCB:Approved Indicates code approval by CCB
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add command that uses an input parameter Symbol name cleanup and remainder of pattern/convention fixes
2 participants