[Licenses Inventory] Update to v4.0.6 (#161)

* chore(#160): update of LicensesInventory (v4.0.6)

Integration of the work done by my colleague Laurent Body (LicensesInventory 4.0.6).

Tested-by: Pierre-Yves Lapersonne <pierreyves.lapersonne@orange.com>
Reviewed-by: Pierre-Yves Lapersonne <pierreyves.lapersonne@orange.com>
Co-authored-by: Laurent Body <laurent.body@orange.com>
Co-authored-by: Pierre-Yves Lapersonne <pierreyves.lapersonne@orange.com>
Signed-off-by: Pierre-Yves Lapersonne <pierreyves.lapersonne@orange.com>

* chore(#160): add entry in CHANGELOG

Signed-off-by: Pierre-Yves Lapersonne <pierreyves.lapersonne@orange.com>

---------

Signed-off-by: Pierre-Yves Lapersonne <pierreyves.lapersonne@orange.com>
Co-authored-by: Laurent Body <laurent.body@orange.com>

Author: pylapp

CHANGELOG.md

@@ -11,6 +11,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Bug and feature request templates, and other files for the hygiene of the project
 
+### Changed
+
+- [Licenses Inventory] Update to v4.0.6 ([#160](https://github.com/Orange-OpenSource/floss-toolbox/issues/160))
+
 ## [2.20.0](https://github.com/Orange-OpenSource/floss-toolbox/compare/2.20.0..2.19.0) - 2024-04-04
 
 ### Added

toolbox/LicensesInventory/README.md

@@ -4,6 +4,7 @@ Table of Contents
 =================		
    * [Licenses inventory](#licenses-inventory)
       * [Disclaimer](#disclaimer)
+      * [Developer notice](#developer-notice)
       * [What the tool does](#what-the-tool-does)
       * [Prerequisites](#prerequisites)
       * [Fill the configuration file](#fill-the-configuration-file)
@@ -39,6 +40,31 @@ The tool searches a license for each dependency found in the files to treat.
 **This is an experimental feature designed and implemented by a blind colleague, you must always keep in mind our [Code of Conduct](https://github.com/Orange-OpenSource/floss-toolbox/blob/dev/CODE_OF_CONDUCT.md) for any issues nor comments, and be benevolent and kind.
 This is mandatory.**
 
+## Developer notice
+
+- Unit tests: in *tests/unittests*
+- Integration tests: in *tests/integrationtests*
+- To test the main: in *sources/test_main.py*
+    with the data in *sources/data_to_test_main*
+
+Do not delete the file 'to_add_this_folder_to_git.tmp' in:
+    real_data/licenses*
+    real_data/no_file
+
+For integrationtest/test_3_print:
+- you have to uncomment the first line in the test method to see the displays
+- the test does not pass: it is normal, it tests the displaying after testing, you have to comment this line: the test will pass
+
+After executing of the integration tests:
+- delete the directories 'real_data/licenses*'
+- execute the following commands:
+
+```shell
+    git checkout tests\integrationtests\real_data\licenses
+    git checkout tests\integrationtests\real_data\licenses_with_errors
+    git checkout tests\integrationtests\real_data\licenses_with_retry_after
+```
+
 ## What the tool does
 
 1. Read the file 'config.ini' ;
@@ -79,11 +105,11 @@ For example:
 # Where to find the package manager files above, must be defined, target must exist
 path to parse = /absolute/path/to/project_to_test
 # The name of the package manager file to process stored above, must be defined
-the filenames = go.mod
+the filenames = go.mod, build.gradle, build.gradle.kts, package.json
 # For outputs, must be defined, target must exists
 path to store the licenses = /absolute/path/to/project_to_test-licences
 # Erros maangement if requests failed
-number of authorized successive errors = 1
+number of authorized successive errors = 2
 ```
 
 where:
@@ -112,7 +138,7 @@ python3 -m pytest -s tests/integrationtests/*.py
 python3 -m pytest tests/unittests/*.py
 ```
 
-To run the unit tests, you must get the assets attached as artificats to [the release you got](https://github.com/Orange-OpenSource/floss-toolbox/releases).
+To run the unit tests, you must get the assets attached as artifacts to [the release you got](https://github.com/Orange-OpenSource/floss-toolbox/releases).
 For integration tests, get the *real_data* folder in the *integrationtests* folder and move it to the same folder in your project.
 For unit tests, get the *data* folder in the *unittests* folder and move it to the same folder in your project.
 
@@ -231,4 +257,4 @@ A file 'licenses.txt' is created in the folder 'licenses'.
 This file contains the list of the licenses for each dependency.
 To personalize this folder, use 'config.ini'.
 
-Beware of your proxys or public IP address to not be blocked by such platforms, and avoid flooding them.
+Beware of your proxys or public IP address to not be blocked by such platforms, and avoid flooding them.

toolbox/LicensesInventory/tests/integrationtests/test_1_all_dependencies.py

@@ -40,7 +40,6 @@ def test_new_dependencies(self):
 
         ins_config = CConfig()
         ins_config.path = self.path_data
-        ins_config.filename = "config.ini"
         ins_config.get_the_config()
 
         ins_filter = CFilter()

toolbox/LicensesInventory/tests/integrationtests/test_3_print_with_error_403.py

@@ -25,6 +25,9 @@ class TestDependencies(unittest.TestCase):
 
     """
     Tests with real data
+    Before to test the saving of the dependencies on error, in integrationtests, delete the files in:
+     licenses_with_errors
+     licenses_with_retry_after
     """
 
     @classmethod
@@ -52,6 +55,7 @@ def test_print_with_error_403(self, mock_requests_get):
         the_dependencies_by_platform = ins_dependencies.get_the_dependencies(ins_filter)
         if the_dependencies_by_platform == None:
             return
+            
         # requests
         import requests
         response = requests.models.Response

toolbox/LicensesInventory/tests/integrationtests/test_4_2_dependencies_per_platform_saving_errors.py

@@ -25,6 +25,9 @@ class TestDependencies(unittest.TestCase):
 
     """
     Tests with real data
+    Before to test the saving of the dependencies on error, in integrationtests, delete the files in:
+     licenses_with_errors
+     licenses_with_retry_after
     """
 
     @classmethod
@@ -53,7 +56,6 @@ def test_new_dependencies(self, mock_requests_get):
             return
         self.assertEqual(7, len(the_dependencies_by_platform))
 
-        number = 2
         number = 2
         the_d = the_dependencies_by_platform[CName().cocoapods]
         self.assertEqual(number, len(the_d))