Skip to content
This repository has been archived by the owner on Oct 15, 2024. It is now read-only.

Kdb cli rewrite #4807

Closed
wants to merge 22 commits into from
Closed

Kdb cli rewrite #4807

wants to merge 22 commits into from

Conversation

hannes99
Copy link
Contributor

@hannes99 hannes99 commented Jan 4, 2023

Issue: #4431

Basics

  • Short descriptions of your changes are in the release notes
    (added as entry in doc/news/_preparation_next_release.md which
    contains _(my name)_)
    Please always add something to the release notes.
  • Details of what you changed are in commit messages
    (first line should have module: short statement syntax)
  • References to issues, e.g. close #X, are in the commit messages.
  • The buildservers are happy. If not, fix in this order:
    • add a line in doc/news/_preparation_next_release.md
    • reformat the code with scripts/dev/reformat-all
    • make all unit tests pass
    • fix all memleaks
  • The PR is rebased with current master.

Checklist

  • I added unit tests for my code
  • I fully described what my PR does in the documentation
    (not in the PR description)
  • I fixed all affected documentation (see Documentation Guidelines)
  • I fixed all affected decisions (see Decision Process)
  • I added code comments, logging, and assertions as appropriate (see Coding Guidelines)
  • I updated all meta data (e.g. README.md of plugins and METADATA.ini)
  • I mentioned every code not directly written by me in reuse syntax

Review

Labels

  • Add the "work in progress" label if you do not want the PR to be reviewed yet.
  • Add the "ready to merge" label if the basics are fulfilled and no further pushes are planned by you.

@hannes99
kdb-cli: add new main.c
c877b59 
and add command.h containing helpful macros and a struct def that is
needed later
@hannes99
kdb-cli: add helper functions
cba1c28 
... to command.c for resolving bookmarks in keynames.
@hannes99
kdb-cli: rewrite get command
19203b4 
... and remove cpp implementation
@hannes99
kdb-cli: rewrite ls command
38ce374 
... and remove cpp implementation
@hannes99
kdb-cli: rewrite basename command
701dcfe 
... and remove cpp implementation
@hannes99
kdb-cli: rewrite namespace command
e312638 
... and remove cpp implementation
@hannes99
kdb-cli: rewrite dirname command
3a294d8 
... and remove cpp implementation
@hannes99
kdb-cli: rewrite cmerge command
9bfd674 
.. and remove cpp implementation
@hannes99
kdb-cli: add mountpoint command structure
6c21835
@hannes99
kdb-cli: add formatted and log-level dependant output
9b955b2 
... and a GET_BASIC_OPTIONS macro for reading all basic basic options
at the start of a command
@atmaxinger atmaxinger self-requested a review February 3, 2023 18:51
@hannes99
kdb-cli: rewrite set
42cfb51 
... and (partial) fix #3742, fix #4028, fix #1164
github-advanced-security[bot]
github-advanced-security bot found potential problems Mar 1, 2023
View reviewed changes
src/tools/kdb/colors.c
}
char * tmp = elektraMalloc (elektraStrLen (escapeCode) + elektraStrLen (text) + elektraStrLen (RESET) + 1);
strcpy (tmp, escapeCode);
strcat (tmp, text);

Check failure

Code scanning / CodeQL

Potentially unsafe use of strcat

Always check the size of the source buffer when using strcat.
src/tools/kdb/mountpoint-mount.c

printKsNames (currentMountConfig);

printf ("MOUNT");

Check failure

Code scanning / CodeQL

Missing return statement

Function execMount should return a value of type int but does not return a value here
src/tools/kdb/mountpoint-remount.c

int execRemount (KeySet * options, Key * errorKey)
{
printf ("RE-MOUNT");

Check failure

Code scanning / CodeQL

Missing return statement

Function execRemount should return a value of type int but does not return a value here
src/tools/kdb/mountpoint-umount.c

int execUmount (KeySet * options, Key * errorKey)
{
printf ("UN-MOUNT");

Check failure

Code scanning / CodeQL

Missing return statement

Function execUmount should return a value of type int but does not return a value here
src/tools/kdb/mountpoint.c
return mountSubcommands[i].exec (options, errorKey);
}
}
}

Check failure

Code scanning / CodeQL

Missing return statement

Function execMountpoint should return a value of type int but does not return a value here
src/tools/kdb/cmerge.c
return result;
}

int execCmerge (KeySet * options, Key * errorKey)

Check warning

Code scanning / CodeQL

Poorly documented large function

Poorly documented function: fewer than 2% comments for a function of 157 lines.
src/tools/kdb/mountpoint-mount.c

int execMount (KeySet * options, Key * errorKey)
{
int ret = 0;

Check notice

Code scanning / CodeQL

Unused local variable

Variable ret is not used.
src/tools/kdb/mountpoint-mount.c
elektraKeyToBoolean (GET_OPTION_KEY (options, "verbose"), &verbose);
}

const char * path = GET_OPTION (options, "path");

Check notice

Code scanning / CodeQL

Unused local variable

Variable path is not used.
src/tools/kdb/get.c

void printOptions (elektraLookupFlags options)
{
// :'<,'>s/\(.*\)/^Iif(options \& \1) printf("\1 ");

Check notice

Code scanning / CodeQL

Commented-out code

This comment appears to contain commented-out code.
src/tools/kdb/mountpoint-mount.c

KeySet * currentMountConfig = getMountConfig (handle, errorKey);

Key * mountpointKey = keyNew (mountpoint, KEY_END);

Check notice

Code scanning / CodeQL

Unused local variable

Variable mountpointKey is not used.
github-advanced-security[bot]
github-advanced-security bot found potential problems Mar 2, 2023
View reviewed changes
src/tools/kdb/mv.c
ADD_BASIC_OPTIONS (spec, COMMAND_SPEC_KEY (COMMAND_NAME))
}

int execMv (KeySet * options, Key * errorKey)

Check warning

Code scanning / CodeQL

Poorly documented large function

Poorly documented function: fewer than 2% comments for a function of 106 lines.
github-advanced-security[bot]
github-advanced-security bot found potential problems Mar 2, 2023
View reviewed changes
src/tools/kdb/cp.c
ADD_BASIC_OPTIONS (spec, COMMAND_SPEC_KEY (COMMAND_NAME))
}

int execCp (KeySet * options, Key * errorKey)

Check warning

Code scanning / CodeQL

Poorly documented large function

Poorly documented function: fewer than 2% comments for a function of 113 lines.
@hannes99 hannes99 force-pushed the kdb_cli_rewrite branch 5 times, most recently from d1590d9 to af46517 Compare March 6, 2023 16:19
@hannes99 hannes99 closed this May 11, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@atmaxinger atmaxinger Awaiting requested review from atmaxinger

Assignees
No one assigned
Labels
lang/c lang/cpp work in progress
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@hannes99