Add repositories info so the generation of docs TIP and overall TIR have the info they need to render the doc. by victorpablosceruelo · Pull Request #100 · opendevstack/ods-document-generation-svc

victorpablosceruelo · 2022-04-13T14:25:33Z

Adds fixture to the tests, basically the repositories info, but some more changes are there too.
jekins -> jenkins (in jenkins log param). WARN: this forces to upgrade the shared lib too.
computes values gitUrl and doInstall for each repository.
improves some development utilities.

…to-overall-tir-and-tip

s2oBCN · 2022-04-19T06:23:20Z

src/main/groovy/org/ods/doc/gen/leva/doc/services/LeVADocumentService.groovy

        junit.getNumberOfTestCases(testData.testResults) - testIssues.count { !it.isUnexecuted }
    }

+    private computeRepositoriesDataNeededInDocs(Map data) {


please, can you change computeRepositoriesDataNeededInDocs by "updateRepositoryData"

s2oBCN · 2022-04-19T06:26:24Z

src/main/groovy/org/ods/doc/gen/project/data/ProjectData.groovy

-                supplier: "mySupplier-A",
-                version: "myVersion-A",
-                references: "myReferences-A"
+                name: repo.name ? repo.name : repo.id,


In the other class you said repo.name:
String repoName = repo.id as String
repoName = "${projectId}-${repoName}"
Here is different?
And when is possible to don't have the repo.name?

This needs more work.
Seems to be in the original commit you forgot about this information.
We are now determining how to obtain this information.
Thanks for pointing to it.

s2oBCN · 2022-04-19T06:33:19Z

src/test/groovy/org/ods/doc/gen/leva/doc/fixture/LevaDocTestValidator.groovy

        unzipGeneratedArtifact(buildId)
        if (GENERATE_EXPECTED_PDF_FILES) {
-            copyDocWhenRecording(buildId)
+            boolean comparisonResult = compareFiles(buildId)


Please remove all this part as it will add a lot of time to the test, when if this is GENERATE_EXPECTED_PDF_FILES=true, we expect to copy the results.

Please take a look at the whole change, not just two lines.
We are updating the docs, but only if we need to.
Pdfs source code can change while the visual result remains the same.
Please comment again if you want us to remove it.

Please, don't put this code, this will add a lot of time and not needed

Victor to so2:
Please do not close conversations if you use soft arguments in your last words. Can't answer them.

It is not needed for you because you did not took time debugging and fixing a single document. Why do I have to update all of them when only one is wrong? Just because you do not like the idea of having two more lines of code? It is nonsense.

s2oBCN · 2022-04-19T06:35:03Z

src/test/groovy/org/ods/doc/gen/leva/doc/fixture/LevaDocTestValidator.groovy

            FileUtils.copyFile(actualDoc(buildId), reportPdfDoc(buildId))
        }
+
+        if (!filesAreEqual) {


This is the else of the line 59.
Improve the else of the if.

We'll do that if previous change is accepted. If not, we'll remove this lines because they are related to the previous ones.

s2oBCN · 2022-04-19T06:37:21Z

src/test/groovy/org/ods/doc/gen/leva/doc/fixture/ProjectRepositoryFixture.groovy

@@ -0,0 +1,49 @@
+package org.ods.doc.gen.leva.doc.fixture
+
+class ProjectRepositoryFixture {


This file does not scale to more projects

Yours neither. This makes it possible to test ordgp project.
If we remove them, tests fail.
It is obvious that we'll have to fix your work in the future, but right now we can live with it.

No, this is not true. This data does not scale at all

Victor to so2:
Please do not close conversations if you use soft arguments in your last words. Can't answer them.
Yours code in LevaDocDataFixture scales, right?
Example:
targetEnvironmentToken: "D",

Please, take a look to the code we have to live with just because you can tell us ours is bad while we cannot tell you yours can be improved.

s2oBCN · 2022-04-19T06:38:50Z

src/test/groovy/org/ods/doc/gen/leva/doc/fixture/LevaDocDataFixture.groovy

        data.build = buildJobParams(projectFixture)
        data.git =  buildGitData(projectFixture)
        data.openshift = [targetApiUrl:"https://openshift-sample"]
+        data.repositories = new ProjectRepositoryFixture().load()


Previously we were using getModuleData()
If we don't need it anymor,, please clean the code.

getModuleData is still used to generate component information sent. Please notice that when documents use component information they do not use repositories information.

… github.com:/opendevstack/ods-document-generation-svc into feature/add-component-params-to-overall-tir-and-tip

s2oBCN · 2022-04-19T19:30:27Z

src/test/groovy/org/ods/doc/gen/leva/doc/fixture/LevaDocTestValidator.groovy

        unzipGeneratedArtifact(buildId)
        if (GENERATE_EXPECTED_PDF_FILES) {
-            copyDocWhenRecording(buildId)
+            boolean comparisonResult = compareFiles(buildId)


Please, don't put this code, this will add a lot of time and not needed

Victor to so2:
Please do not close conversations if you use soft arguments in your last words. Can't answer them.

It is not needed for you because you did not took time debugging and fixing a single document. Why do I have to update all of them when only one is wrong? Just because you do not like the idea of having two more lines of code? It is nonsense.

s2oBCN · 2022-04-19T20:05:16Z

src/test/groovy/org/ods/doc/gen/leva/doc/fixture/LevaDocDataFixture.groovy

        data.build = buildJobParams(projectFixture)
        data.git =  buildGitData(projectFixture)
        data.openshift = [targetApiUrl:"https://openshift-sample"]
+        data.repositories = new ProjectRepositoryFixture().load()


1- The data in getModuleDatais the same you put here.
2- Shared is sending this data for everytype of doc?

1-That is not true. While the previous contains only info for a component, new code cotains different information for each code.
2-If you are asking this, you did not expend enough time reading my code.

s2oBCN · 2022-04-19T20:05:50Z

src/test/groovy/org/ods/doc/gen/leva/doc/fixture/ProjectRepositoryFixture.groovy

@@ -0,0 +1,49 @@
+package org.ods.doc.gen.leva.doc.fixture
+
+class ProjectRepositoryFixture {


No, this is not true. This data does not scale at all

Victor to so2:
Please do not close conversations if you use soft arguments in your last words. Can't answer them.
Yours code in LevaDocDataFixture scales, right?
Example:
targetEnvironmentToken: "D",

Please, take a look to the code we have to live with just because you can tell us ours is bad while we cannot tell you yours can be improved.

metmajer · 2022-04-20T07:59:30Z

@s2oBCN @victorpablosceruelo I suggest we move the conversation to an internal place now

zxBCN Pablos_Ceruelo,Victor (IT EDS) EXTERNAL added 2 commits April 12, 2022 18:56

Enables tests previously disabled.

a6bd3d9

Load repositories test data 4 TIP and overall_TIR

1a4cf0f

victorpablosceruelo requested review from martsec and metmajer as code owners April 13, 2022 14:25

victorpablosceruelo requested review from hrcornejo and jafarre-bi and removed request for martsec and metmajer April 13, 2022 14:26

Victor Pablos Ceruelo added 13 commits April 13, 2022 16:34

ProjectRepositoryFixture

f29d06b

Need better examples.

42e8385

Need to save generated pdf when not as expected one.

c87ed12

Generates doInstall info before calling to generate doc.

1e20f00

Do not update pdfs if they are still valid.

b9a871f

Improves example input data.

ba6df8b

Updates expected pdf only if changes detected.

e7812ea

Renames method name.

9f3f3ef

Generated repos urls in docGen.

8dcb4c8

Fixes typo in urls, TIP docs.

badfc5d

computeRepositoriesDataNeededInDocs

03db887

Expected overall TIR.

9a4a6f9

Changed expected pdfs, since input data changed.

3ee8932

victorpablosceruelo changed the title ~~Enables tests previously disabled.~~ Add repositories info so the generation of docs TIP and overall TIR have the info they need to render the doc. Apr 18, 2022

changelog

24ebad9

victorpablosceruelo requested a review from jorge-romero April 18, 2022 13:49

Merge branch 'feature/moveLevaDoc' into feature/add-component-params-…

aedf1ed

…to-overall-tir-and-tip

jafarre-bi approved these changes Apr 18, 2022

View reviewed changes

victorpablosceruelo requested a review from s2oBCN April 18, 2022 15:20

s2oBCN requested changes Apr 19, 2022

View reviewed changes

victorpablosceruelo requested a review from s2oBCN April 19, 2022 10:07

Changes method name.

c1f6462

Merge branch 'feature/add-component-params-to-overall-tir-and-tip' of…

b26ff81

… github.com:/opendevstack/ods-document-generation-svc into feature/add-component-params-to-overall-tir-and-tip

victorpablosceruelo marked this pull request as draft April 19, 2022 13:01

s2oBCN requested changes Apr 19, 2022

View reviewed changes

Victor Pablos Ceruelo added 7 commits April 20, 2022 12:57

Loads repositories metadata from repositories yml files.

9952740

Fixes download method for templates.

e874179

This seems to be a bug inherited from sharedLib

84746f3

Change in tmp file name.

429d5d0

Needed to ensure we do not use uncontrolled field values.

5a7eb06

Fixes incorrect data.

7b946bc

Wiremock resources.

2f47b39

		@@ -0,0 +1,49 @@
		package org.ods.doc.gen.leva.doc.fixture

		class ProjectRepositoryFixture {

Comments

Conversation

victorpablosceruelo commented Apr 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

s2oBCN Apr 19, 2022 • edited by victorpablosceruelo Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

s2oBCN Apr 19, 2022 • edited by victorpablosceruelo Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

s2oBCN Apr 19, 2022 • edited by victorpablosceruelo Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

s2oBCN Apr 19, 2022 • edited by victorpablosceruelo Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

metmajer commented Apr 20, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

victorpablosceruelo commented Apr 13, 2022 •

edited

Loading

s2oBCN Apr 19, 2022 •

edited by victorpablosceruelo

Loading

s2oBCN Apr 19, 2022 •

edited by victorpablosceruelo

Loading

s2oBCN Apr 19, 2022 •

edited by victorpablosceruelo

Loading

s2oBCN Apr 19, 2022 •

edited by victorpablosceruelo

Loading