LPS-115484 Token definitions API and implementation #111

izaera · 2020-07-14T11:45:54Z

This PR defines the initial token definitions API and implementation. We will iterate on this PR to refine the API and maybe provide more functionality.

Initially we sent brianchandotcom#91176 to Brian, but he made some objections which led to a full rework of the PR.

The main reasons to rework the PR were:

In the previous PR we assumed that every theme is deployed in a single OSGi bundle but this is something that, even if it is usually true, it is not mandatory given the Portal architecture.
In the previous PR we didn't map from themeId to Bundle, thus it was incorrect.
Brian asked to rename token-definition.json to theme-token-definition.json, something which is incorrect because we may define tokens for things that are not themes.

So, after reviewing the three points we came up with a model where token definitions are associated to OSGi Bundles alone, not related to themes yet (this PR).

In the future we may provide tools to map from themes to OSGi bundles. Even if the existence of a bundle that contains the theme is not enforced by the portal we can define it as a requisite if you want to use token definitions and nothing would break/become inconsistent.

Also, the current API just lists all available token definitions, but doesn't let you query by any criteria. We may add more methods to the TokenDefinitionRegistry service in the future to query token definitions as needed.

This PR doesn't modify anything in the UI nor does it execute any code (because nobody uses TokenDefinitionRegistry yet). However, I have provided units tests to cover almost all production code.

In addition, once we add the token-definition.json file in classic-theme, I will test it manually to make sure it runs in production too.

liferay-continuous-integration · 2020-07-14T11:45:58Z

To conserve resources, the PR Tester does not automatically run for every pull.

If your code changes were already tested in another pull, reference that pull in this pull so the test results can be analyzed.

If your pull was never tested, comment "ci:test" to run the PR Tester for this pull.

izaera · 2020-07-14T11:49:42Z

Converting to draft so that we don't forward it without the Classic's token-definition.json file.

izaera · 2020-07-14T11:49:50Z

ci:test:sf

izaera · 2020-07-14T11:50:54Z

ci:test:relevant

liferay-continuous-integration · 2020-07-14T11:54:16Z

❌ ci:test:sf - 0 out of 1 jobs passed in 3 minutes

Click here for more details.

Base Branch:

Branch Name: master
Branch GIT ID: 76f17290c7dd17e02dbd73c3babb438de273a272

Sender Branch:

Branch Name: LPS-115484
Branch GIT ID: a8873fe9ba2a1812f8c9380aebc34f68f89af7ea

0 out of 1jobs PASSED

1 Failed Jobs:

~~test-portal-source-format~~

For more details click here.

     [java] java.lang.Exception: Found 1 formatting issues:
     [java] 1: ./build.properties expected:<...eme,\
     [java]     #    apps/[frontend-token,\
     [java]     #    apps/]gogo-shell,\
     [java]     #  ...> but was:<...eme,\
     [java]     #    apps/[]gogo-shell,\
     [java]     #  ...>
     [java] 
     [java] 	at com.liferay.source.formatter.SourceFormatter.format(SourceFormatter.java:448)
     [java] 	at com.liferay.source.formatter.SourceFormatter.main(SourceFormatter.java:269)
[stopwatch] [run.batch.test.action: 1:09.691 sec]
     [echo] The following error occurred while executing this line:
     [echo] /opt/dev/projects/github/liferay-portal/portal-impl/build.xml:694: Java returned: 1
      [get] Getting: http://test-1-3/job/test-portal-source-format/4191//consoleText
      [get] To: /opt/dev/projects/github/liferay-portal/20200714045401793.txt
   [delete] Deleting: /opt/dev/projects/github/liferay-portal/20200714045401793.txt
  [typedef] Could not load definitions from resource org/apache/maven/artifact/ant/antlib.xml. It could not be found.
  [taskdef] Could not load definitions from resource org/jacoco/ant/antlib.xml. It could not be found.
   [delete] Deleting: /opt/dev/projects/github/liferay-portal/null204327890.properties
merge-test-results:

[mkdir] Created dir: /opt/dev/projects/github/liferay-portal/test-results

[junitreport] Processing /opt/dev/projects/github/liferay-portal/test-results/TESTS-TestSuites.xml to /tmp/null1662882026

[junitreport] Loading stylesheet jar:file:/opt/java/ant/lib/ant-junit.jar!/org/apache/tools/ant/taskdefs/optional/junit/xsl/junit-frames.xsl

[junitreport] Transform time: 1077ms

[junitreport] Deleting: /tmp/null1662882026

[echo] A report with all the test results can be found at test-results/html/index.html.

[mkdir] Created dir: /opt/dev/projects/github/liferay-jenkins-ee/test-results

[copy] Copying 1 file to /opt/dev/projects/github/liferay-jenkins-ee/test-results

[echo] run.batch.test.tear.down.start.timestamp: 07-14-2020 04:54:07:500 PDT

[stopwatch] [run.batch.test.tear.down: 0.000 sec]

[echo]

[echo] Ant GC log:

[echo]

[echo] Java HotSpot(TM) 64-Bit Server VM (25.121-b13) for linux-amd64 JRE (1.8.0_121-b13), built on Dec 12 2016 16:36:53 by "java_re" with gcc 4.3.0 20080428 (Red Hat 4.3.0-8)

[echo] Memory: 4k page, physical 32902104k(2521424k free), swap 0k(0k free)

izaera · 2020-07-14T11:58:28Z

I don't know why the SF failed... 🤷

liferay-continuous-integration · 2020-07-14T12:06:21Z

Jenkins Build:test-portal-source-format#4191
Jenkins Report:jenkins-report.html
Jenkins Suite: sf
Pull Request:liferay-frontend#111
Spira Release:/Liferay DXP 7.3/Pull Request/ci:test:sf
Spira Release Build:master - izaera > liferay-frontend - PR#111
Spira Jenkins Build:publish-spira-report#597

liferay-continuous-integration · 2020-07-14T13:33:54Z

✔️ ci:test:stable - 20 out of 20 jobs passed

✔️ ci:test:relevant - 44 out of 44 jobs passed in 1 hour 26 minutes

Click here for more details.

Base Branch:

Branch Name: master
Branch GIT ID: 76f17290c7dd17e02dbd73c3babb438de273a272

Copied in Private Modules Branch:

Branch Name: master-private
Branch GIT ID: 2d61577aa6a76425e17132e68f5aa901f720a686

ci:test:stable - 20 out of 20 jobs PASSED

20 Successful Jobs:

ci:test:relevant - 44 out of 44 jobs PASSED

44 Successful Jobs:

For more details click here.

izaera · 2020-07-14T13:36:58Z

ci:test:sf

liferay-continuous-integration · 2020-07-14T13:39:48Z

❌ ci:test:sf - 0 out of 1 jobs passed in 3 minutes

Click here for more details.

Base Branch:

Branch Name: master
Branch GIT ID: 76f17290c7dd17e02dbd73c3babb438de273a272

Sender Branch:

Branch Name: LPS-115484
Branch GIT ID: a8873fe9ba2a1812f8c9380aebc34f68f89af7ea

0 out of 1jobs PASSED

1 Failed Jobs:

~~test-portal-source-format~~

For more details click here.

     [java] java.lang.Exception: Found 1 formatting issues:
     [java] 1: ./build.properties expected:<...eme,\
     [java]     #    apps/[frontend-token,\
     [java]     #    apps/]gogo-shell,\
     [java]     #  ...> but was:<...eme,\
     [java]     #    apps/[]gogo-shell,\
     [java]     #  ...>
     [java] 
     [java] 	at com.liferay.source.formatter.SourceFormatter.format(SourceFormatter.java:448)
     [java] 	at com.liferay.source.formatter.SourceFormatter.main(SourceFormatter.java:269)
[stopwatch] [run.batch.test.action: 1:09.454 sec]
     [echo] The following error occurred while executing this line:
     [echo] /opt/dev/projects/github/liferay-portal/portal-impl/build.xml:694: Java returned: 1
      [get] Getting: http://test-1-3/job/test-portal-source-format/4195//consoleText
      [get] To: /opt/dev/projects/github/liferay-portal/20200714063934955.txt
   [delete] Deleting: /opt/dev/projects/github/liferay-portal/20200714063934955.txt
  [typedef] Could not load definitions from resource org/apache/maven/artifact/ant/antlib.xml. It could not be found.
  [taskdef] Could not load definitions from resource org/jacoco/ant/antlib.xml. It could not be found.
   [delete] Deleting: /opt/dev/projects/github/liferay-portal/null1736125689.properties
merge-test-results:

[mkdir] Created dir: /opt/dev/projects/github/liferay-portal/test-results

[junitreport] Processing /opt/dev/projects/github/liferay-portal/test-results/TESTS-TestSuites.xml to /tmp/null49153550

[junitreport] Loading stylesheet jar:file:/opt/java/ant/lib/ant-junit.jar!/org/apache/tools/ant/taskdefs/optional/junit/xsl/junit-frames.xsl

[junitreport] Transform time: 194ms

[junitreport] Deleting: /tmp/null49153550

[echo] A report with all the test results can be found at test-results/html/index.html.

[mkdir] Created dir: /opt/dev/projects/github/liferay-jenkins-ee/test-results

[copy] Copying 1 file to /opt/dev/projects/github/liferay-jenkins-ee/test-results

[echo] run.batch.test.tear.down.start.timestamp: 07-14-2020 06:39:39:400 PDT

[stopwatch] [run.batch.test.tear.down: 0.000 sec]

[echo]

[echo] Ant GC log:

[echo]

[echo] Java HotSpot(TM) 64-Bit Server VM (25.121-b13) for linux-amd64 JRE (1.8.0_121-b13), built on Dec 12 2016 16:36:53 by "java_re" with gcc 4.3.0 20080428 (Red Hat 4.3.0-8)

[echo] Memory: 4k page, physical 32902104k(411188k free), swap 0k(0k free)

jbalsas · 2020-07-14T13:52:21Z

I don't know why the SF failed... 🤷

You better figure it out then 😂

liferay-continuous-integration · 2020-07-15T14:49:02Z

✔️ ci:test:sf - 1 out of 1 jobs passed in 3 minutes

Click here for more details.

Base Branch:

Branch Name: master
Branch GIT ID: 76f17290c7dd17e02dbd73c3babb438de273a272

Sender Branch:

Branch Name: LPS-115484
Branch GIT ID: 22a8281702d74493785158383631f9a351e322b3

1 out of 1jobs PASSED

1 Successful Jobs:

test-portal-source-format

For more details click here.

liferay-continuous-integration · 2020-07-15T15:45:21Z

Jenkins Build:test-portal-source-format#3942
Jenkins Report:jenkins-report.html
Jenkins Suite: sf
Pull Request:liferay-frontend#111
Spira Release:/Liferay DXP 7.3/Pull Request/ci:test:sf
Spira Release Build:master - izaera > liferay-frontend - PR#111
Spira Jenkins Build:publish-spira-report#727

liferay-continuous-integration · 2020-07-15T15:50:30Z

✔️ ci:test:stable - 20 out of 20 jobs passed

✔️ ci:test:relevant - 46 out of 46 jobs passed in 1 hour 17 minutes

Click here for more details.

Base Branch:

Branch Name: master
Branch GIT ID: e67026449a8a6dae28fc7a7da27e3ff6a3f780b6

Copied in Private Modules Branch:

Branch Name: master-private
Branch GIT ID: 2d61577aa6a76425e17132e68f5aa901f720a686

ci:test:stable - 20 out of 20 jobs PASSED

20 Successful Jobs:

ci:test:relevant - 46 out of 46 jobs PASSED

46 Successful Jobs:

For more details click here.

liferay-continuous-integration · 2020-07-15T15:50:45Z

All required test suite(s) passed.
Forwarding pullrequest to brianchandotcom.

liferay-continuous-integration · 2020-07-15T15:51:15Z

Pull request has been successfully forwarded to brianchandotcom#91387

liferay-continuous-integration · 2020-07-15T15:53:52Z

Jenkins Build:test-portal-acceptance-pullrequest(master)#6666
Jenkins Report:jenkins-report.html
Jenkins Suite: relevant
Pull Request:liferay-frontend#111
Spira Release:/Liferay DXP 7.3/Pull Request/ci:test:relevant
Spira Release Build:master - izaera > liferay-frontend - PR#111 - 2020-07-15[07:32:55]
Spira Jenkins Build:publish-spira-report#730

liferay-continuous-integration · 2020-07-15T15:58:48Z

✔️ ci:test:stable - 20 out of 20 jobs passed

✔️ ci:test:relevant - 46 out of 46 jobs passed in 1 hour 12 minutes

Click here for more details.

Base Branch:

Branch Name: master
Branch GIT ID: e67026449a8a6dae28fc7a7da27e3ff6a3f780b6

Copied in Private Modules Branch:

Branch Name: master-private
Branch GIT ID: 2d61577aa6a76425e17132e68f5aa901f720a686

ci:test:stable - 20 out of 20 jobs PASSED

20 Successful Jobs:

ci:test:relevant - 46 out of 46 jobs PASSED

46 Successful Jobs:

For more details click here.

liferay-continuous-integration · 2020-07-15T15:59:02Z

All required test suite(s) passed.
Forwarding pullrequest to brianchandotcom.

liferay-continuous-integration · 2020-07-15T15:59:03Z

Closed pull request will not be forwarded.

liferay-continuous-integration · 2020-07-15T16:01:11Z

Jenkins Build:test-portal-acceptance-pullrequest(master)#6529
Jenkins Report:jenkins-report.html
Jenkins Suite: relevant
Pull Request:liferay-frontend#111
Spira Release:/Liferay DXP 7.3/Pull Request/ci:test:relevant
Spira Release Build:master - izaera > liferay-frontend - PR#111 - 2020-07-15[07:46:19]
Spira Jenkins Build:publish-spira-report#3855

izaera added 5 commits July 14, 2020 13:01

LPS-115484 Add two new projects to hold token definition feature

f31833b

LPS-115484 Define token definition API

6e68241

LPS-115484 Add JSON schema file for token definition files

600f881

LPS-115484 Implement token definition feature

55fa7d9

LPS-115484 Test token definition feature

a8873fe

izaera marked this pull request as draft July 14, 2020 11:49

liferay-continuous-integration added ci:test:sf - pending ci:test:sf - failure and removed ci:test:sf - pending labels Jul 14, 2020

liferay-continuous-integration added ci:test:relevant - pending ci:test:stable - pending ci:test:relevant - success ci:test:stable - success and removed ci:test:relevant - pending ci:test:stable - pending labels Jul 14, 2020

liferay-continuous-integration added ci:test:sf - pending ci:test:sf - failure and removed ci:test:sf - failure ci:test:sf - pending labels Jul 14, 2020

liferay-continuous-integration added ci:test:sf - pending ci:test:relevant - pending ci:test:stable - pending ci:test:sf - success and removed ci:test:sf - failure ci:test:relevant - pending ci:test:stable - pending ci:test:sf - pending labels Jul 15, 2020

liferay-continuous-integration added ci:test:relevant - success ci:test:stable - success and removed ci:test:relevant - pending ci:test:stable - pending labels Jul 15, 2020

liferay-continuous-integration mentioned this pull request Jul 15, 2020

LPS-115484 Token definitions API and implementation brianchandotcom/liferay-portal#91387

Closed

liferay-continuous-integration closed this Jul 15, 2020

liferay-continuous-integration added ci:test:relevant - success ci:test:stable - success and removed ci:test:relevant - success ci:test:stable - success labels Jul 15, 2020

izaera mentioned this pull request Jul 17, 2020

This is an iteration over https://github.com/liferay-frontend/liferay-portal/pull/111 #130

Closed

liferay-continuous-integration mentioned this pull request Jul 17, 2020

This is an iteration over https://github.com/liferay-frontend/liferay-portal/pull/111 brianchandotcom/liferay-portal#91492

Closed

LPS-115484 Token definitions API and implementation #111

LPS-115484 Token definitions API and implementation #111

Conversation

izaera commented Jul 14, 2020

liferay-continuous-integration commented Jul 14, 2020

izaera commented Jul 14, 2020

izaera commented Jul 14, 2020

izaera commented Jul 14, 2020

liferay-continuous-integration commented Jul 14, 2020

❌ ci:test:sf - 0 out of 1 jobs passed in 3 minutes

Base Branch:

Sender Branch:

1 Failed Jobs:

For more details click here.

izaera commented Jul 14, 2020

liferay-continuous-integration commented Jul 14, 2020

liferay-continuous-integration commented Jul 14, 2020

✔️ ci:test:stable - 20 out of 20 jobs passed

✔️ ci:test:relevant - 44 out of 44 jobs passed in 1 hour 26 minutes

Base Branch:

Copied in Private Modules Branch:

For more details click here.

izaera commented Jul 14, 2020

liferay-continuous-integration commented Jul 14, 2020

❌ ci:test:sf - 0 out of 1 jobs passed in 3 minutes

Base Branch:

Sender Branch:

1 Failed Jobs:

For more details click here.

jbalsas commented Jul 14, 2020

liferay-continuous-integration commented Jul 15, 2020

✔️ ci:test:sf - 1 out of 1 jobs passed in 3 minutes

Base Branch:

Sender Branch:

For more details click here.

liferay-continuous-integration commented Jul 15, 2020

liferay-continuous-integration commented Jul 15, 2020

✔️ ci:test:stable - 20 out of 20 jobs passed

✔️ ci:test:relevant - 46 out of 46 jobs passed in 1 hour 17 minutes

Base Branch:

Copied in Private Modules Branch:

For more details click here.

liferay-continuous-integration commented Jul 15, 2020

liferay-continuous-integration commented Jul 15, 2020

liferay-continuous-integration commented Jul 15, 2020

liferay-continuous-integration commented Jul 15, 2020

✔️ ci:test:stable - 20 out of 20 jobs passed

✔️ ci:test:relevant - 46 out of 46 jobs passed in 1 hour 12 minutes

Base Branch:

Copied in Private Modules Branch:

For more details click here.

liferay-continuous-integration commented Jul 15, 2020

liferay-continuous-integration commented Jul 15, 2020

liferay-continuous-integration commented Jul 15, 2020