Adding headers of the deltacode output in the cli after writing to the json file is over #134

Pratikrocks · 2020-03-12T19:29:23Z

Signed off by: Pratik Dey [email protected]
referencing to issue #130
added headers of the deltacode output to the cli.

Pratikrocks · 2020-03-12T19:34:34Z

@MaJuRG @pombredanne Please kindly review my PR .:)

steven-esser · 2020-03-13T16:42:09Z

configure

@@ -27,7 +27,7 @@ CONFIGURE_ROOT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 if [[ "$PYTHON_EXE" == "" ]]; then
    PYTHON_EXE=python
 fi
-
+PYTHON_EXE=python2.7


What is this for?

Actually I had 3 versions of python in my system to explicitly configure with py2.7 I was using it,else it was showing config errors(I am going to change it now)

steven-esser · 2020-03-13T16:44:40Z

src/deltacode/cli.py

+    click.echo('deltacode_options: {')
+    for option in deltacode.options:
+        click.echo("""   "{}": "{}" """.format(option,deltacode.options[option]))
+    click.echo("}")    
+    click.echo("""deltacode_version: "{}" """.format(__version__))
+    click.echo('deltacode_errors: {}'.format(collect_errors(deltacode)))
+    click.echo('deltas_count: {}'.format(len([d for d in deltas(deltacode, all_delta_types)])))


I do not really care to see these in the output. #130 is relating to just the Number of Deltas and what the different factors are.

I would like to see the counts of each particular Delta type (factors), not much else.

Okay @MaJuRG sir so I am updating this part

Pratikrocks · 2020-03-13T17:05:49Z

@MaJuRG sir I updated it now

steven-esser · 2020-03-13T19:14:48Z

src/deltacode/cli.py

+    click.secho(get_notice(),fg="green")
+    click.echo('deltas_count: {}'.format(len([d for d in deltas(deltacode, all_delta_types)])))
+    click.echo('delta_stats: {')
+    for stat in deltacode.stats.to_dict():
+        click.echo("""   "{}": {}""".format(str(stat),deltacode.stats.to_dict()[stat]))
+    click.echo("}")    


I do not think we need to struture the output like a json file. It adds a lot of noise. I would rather it just be output as key: value and not have JSON brackets or indentation

@MaJuRG sir , updated the content

steven-esser

You did not sign off your last commit.

Also, you should improve your commit messages. A commit message of "Updates" tells me nothing of what has been done. See: https://chris.beams.io/posts/git-commit/

Please rebase your "updates" commits into a single commit and update the commit message to something more detailed using the link above.

Pratikrocks · 2020-03-14T06:02:45Z

@MaJuRG sir, sorry for the delay and inconvenience ,I have made the changes

steven-esser · 2020-03-15T14:27:34Z

configure

@@ -27,7 +27,6 @@ CONFIGURE_ROOT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 if [[ "$PYTHON_EXE" == "" ]]; then
    PYTHON_EXE=python
 fi
-


Re-add this line break

@MaJuRG added the line break

steven-esser · 2020-03-18T14:38:54Z

src/deltacode/cli.py

+    click.echo('deltas_count: {}'.format(len([d for d in deltas(deltacode, all_delta_types)])))
+    click.echo('delta_stats: ')
+    for stat in deltacode.stats.to_dict():
+        click.echo("""   "{}": {}""".format(str(stat),deltacode.stats.to_dict()[stat]))  


I do not think we want these unnecessary spaces in the output. Also, I would like the "stats" to be broken down by "factors" as this is more detailed.

@MaJuRG ,I was actually providing the old_files_count ,files_modifies,files_moves....
in the stats part
What else should we provide ?
should we also provide the stats of new and old file path as it appears in the headers of the delta code json file?

I would like the "stats" to be broken down by "factors" as this is more detailed.

Yes we can provide the factors of each and every deltas in the cli ,and that is actually much elaborate ,however some deltas may be having empty arrays as its "factors" (in case of "added"...) ,what do we need to provide as "factors" in such a case?

Then you just use the base status value.

Yes @MaJuRG I think we can provide both the status and factors for the deltas as that will actually much detailed

@MaJuRG can you please review the changes.

Pratikrocks · 2020-03-22T20:52:12Z

@MaJuRG kindly review this, I made few changes

Now I provided the the deltas which are modified in the CLI (deltas score,factors,old file ,new file...),so this is actually providing a bit more details to the end user about the deltas

Pratikrocks · 2020-04-01T10:46:27Z

@MaJuRG can you review the changes

steven-esser

Can you show me what this looks like in the output?

steven-esser · 2020-04-02T16:04:49Z

src/deltacode/utils.py

+def get_notice_for_cli():
+    """
+    Retrieve the notice text from the NOTICE file for display in the Command Line .
+    """
+    notice_path = os.path.join(os.path.abspath(os.path.dirname(__file__)), 'NOTICE')
+    notice_text = open(notice_path).read()
+
+    delimiter = '\n\n\n'
+    [notice_text, extra_notice_text] = notice_text.split(delimiter, 1)
+    extra_notice_text = delimiter + extra_notice_text
+
+    delimiter = '\n\n '
+    [notice_text, acknowledgment_text] = notice_text.split(delimiter, 1)
+    acknowledgment_text = delimiter + acknowledgment_text
+
+    notice = acknowledgment_text.strip().replace('\n', '')
+
+    return notice


Why do we need this?

@MaJuRG the screen shot which I provided it here is the output of this part (the green area)

@MaJuRG kindly review this, I made few changes

Now I provided the the deltas which are modified in the CLI (deltas score,factors,old file ,new file...),so this is actually providing a bit more details to the end user about the deltas

@MaJuRG sir I updated it now

@MaJuRG now this is the output(for the notice part) when I do not use this additonal function

Why do we need this?

It is added to make the notice output in the CLI look better

I do not want the notice displayed in the section.

Pratikrocks · 2020-04-02T16:56:23Z

@MaJuRG do I need to make some other changes in the CLI output part?

Pratikrocks · 2020-04-13T14:48:38Z

@MaJuRG can you please review it again, I have some changes
when we are generating deltas with options
deltacode -n tests/data/cli/scan_1_file_moved_new.json -o tests/data/cli/scan_1_file_moved_old.json -j - , then there is no need to provide a CLI , as the entire output is displayed in the CLI.

Now when we are printing the delta outputs in a json file then , I am providing a CLI , after the delta comparisons are required.

I felt that it would be better not to have an additional CLI in the first case.

Pratikrocks · 2020-04-13T14:50:16Z

src/deltacode/cli.py

+
+        simplejson.dump(results, outfile, iterable_as_array=True, indent=2)
+        outfile.write('\n')    
+        if outfile.name != '<stdout>' : 


This occours when the -j option is in the json file

steven-esser · 2020-04-13T22:44:42Z

src/deltacode/utils.py

+def get_notice_for_cli():
+    """
+    Retrieve the notice text from the NOTICE file for display in the Command Line .
+    """
+    notice_path = os.path.join(os.path.abspath(os.path.dirname(__file__)), 'NOTICE')
+    notice_text = open(notice_path).read()
+
+    delimiter = '\n\n\n'
+    [notice_text, extra_notice_text] = notice_text.split(delimiter, 1)
+    extra_notice_text = delimiter + extra_notice_text
+
+    delimiter = '\n\n '
+    [notice_text, acknowledgment_text] = notice_text.split(delimiter, 1)
+    acknowledgment_text = delimiter + acknowledgment_text
+
+    notice = acknowledgment_text.strip().replace('\n', '')
+
+    return notice


I do not want the notice displayed in the section.

steven-esser · 2020-04-13T22:44:52Z

src/deltacode/cli.py

+            click.secho("#" * 211 + "\n",fg="yellow")
+            click.secho(" "*70 + "All deltas are generated, view the json file for details" + "\n" , fg="green")
+            click.secho("#" * 211,fg="yellow")


Please remove this. I dont really care for this output.

@MaJuRG , I will be removing the notice and this additional output sections

Pratikrocks · 2020-04-15T13:37:13Z

@MaJuRG , I made the changes in the output of the CLI part.
Now the output will appear as per the above screen shot.
So, in the output I provided the following things:
1.delta counts
2.delta statistics
3.For each deltas I provided the following info:
status , factors , delta score, original path of new file,original path of old file.

Please suggest if some additional details are required :)

Signed-off-by: Pratikrocks <[email protected]>

Pratikrocks · 2020-04-20T13:36:14Z

@MaJuRG , this is the output after making the recommended changes.

Pratikrocks · 2020-04-20T13:40:12Z

Regarding the number of lines changed ,it is more because I rebased the this branch to the tip of the develop branch, so as to reflect the changes here. I only changed the init.py and cli.py rest files are unaltered,The rest changes are present even in the develop branches even

steven-esser · 2021-03-18T19:54:46Z

Closing due to stagnation.

Pratikrocks · 2021-03-19T02:03:17Z

@MaJuRG sir I request review on it and all other or of mine a long back, and for many times I had asked
Even my last comment in all other PR was also for review
I was active throughout , but I never used to get reply satisfactoryl.

steven-esser · 2021-03-19T13:51:51Z

@Pratikrocks Yes this may have fallen through the cracks, sorry about this lack of feedback.

The deltacode repo has been updated since this PR was made with a number of configuration changes. If you can, please rebase your branch, or add your changes to a new branch off of the current develop HEAD. I will make sure to leave prompt feedback if you do!

Pratikrocks · 2021-03-19T14:01:10Z

Hi @MaJuRG , hope you are well,yes there are many changes currently :)
I see now that now deltacode is already ported to py3
But we are not having the support for VirtualCodeBase thing from ScanCode right?
So do you want deltacode to have the support for the VirtualCodeBase , if so I will make a separate PR for it :)?

steven-esser · 2021-03-19T14:07:10Z

Yes, deltacode is now python3.

And yes, we are still looking to support VirtualCodebase, which has not been completed yet. PRs welcome 👍

Pratikrocks · 2021-03-19T14:16:14Z

Okay

Pratikrocks force-pushed the addingCLI branch from d568402 to 3d83c20 Compare March 12, 2020 19:31

steven-esser suggested changes Mar 13, 2020

View reviewed changes

Pratikrocks force-pushed the addingCLI branch from 12ce2bf to d2680ee Compare March 13, 2020 17:03

steven-esser suggested changes Mar 13, 2020

View reviewed changes

Pratikrocks force-pushed the addingCLI branch from f53d937 to a15a0e8 Compare March 13, 2020 19:47

Pratikrocks closed this Mar 13, 2020

Pratikrocks reopened this Mar 13, 2020

Pratikrocks force-pushed the addingCLI branch 2 times, most recently from 51883d1 to 347b685 Compare March 14, 2020 03:51

Pratikrocks force-pushed the addingCLI branch from 347b685 to d468bb8 Compare March 14, 2020 08:37

steven-esser suggested changes Mar 15, 2020

View reviewed changes

Pratikrocks force-pushed the addingCLI branch 2 times, most recently from 5cbcf7a to e0f6000 Compare March 15, 2020 15:47

steven-esser suggested changes Mar 18, 2020

View reviewed changes

Pratikrocks force-pushed the addingCLI branch from 304dbaa to 9c39ef0 Compare March 22, 2020 20:39

Pratikrocks requested a review from steven-esser April 1, 2020 18:37

steven-esser suggested changes Apr 2, 2020

View reviewed changes

Pratikrocks force-pushed the addingCLI branch 2 times, most recently from a443d2d to d9973f8 Compare April 13, 2020 14:39

Pratikrocks commented Apr 13, 2020

View reviewed changes

steven-esser suggested changes Apr 13, 2020

View reviewed changes

Pratikrocks force-pushed the addingCLI branch from 18b8c85 to e83510a Compare April 15, 2020 09:37

Pratikrocks force-pushed the addingCLI branch 3 times, most recently from 41fa884 to 85f7324 Compare April 15, 2020 13:29

added the CLI

2edd57b

Signed-off-by: Pratikrocks <[email protected]>

Pratikrocks force-pushed the addingCLI branch from 6adee0a to 2edd57b Compare April 17, 2020 11:32

steven-esser closed this Mar 18, 2021

Adding headers of the deltacode output in the cli after writing to the json file is over #134

Adding headers of the deltacode output in the cli after writing to the json file is over #134

Conversation

Pratikrocks commented Mar 12, 2020 • edited Loading

Pratikrocks commented Mar 12, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Pratikrocks commented Mar 13, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

steven-esser left a comment

Choose a reason for hiding this comment

Pratikrocks commented Mar 14, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Pratikrocks commented Mar 22, 2020

Pratikrocks commented Apr 1, 2020

steven-esser left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Pratikrocks Apr 2, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Pratikrocks commented Apr 2, 2020

Pratikrocks commented Apr 13, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Pratikrocks commented Apr 15, 2020 • edited Loading

Pratikrocks commented Apr 20, 2020

Pratikrocks commented Apr 20, 2020 • edited Loading

steven-esser commented Mar 18, 2021

Pratikrocks commented Mar 19, 2021

steven-esser commented Mar 19, 2021

Pratikrocks commented Mar 19, 2021 • edited Loading

steven-esser commented Mar 19, 2021

Pratikrocks commented Mar 19, 2021

Pratikrocks commented Mar 12, 2020 •

edited

Loading

Pratikrocks Apr 2, 2020 •

edited

Loading

Pratikrocks commented Apr 15, 2020 •

edited

Loading

Pratikrocks commented Apr 20, 2020 •

edited

Loading

Pratikrocks commented Mar 19, 2021 •

edited

Loading