d543ba5b56
- the prio of messages is now as follows for all themes (RL = realm localization, T = Theme i18n files): RL <variant> > T <variant> > RL <region> > T <region> > RL <language> > T <language> > RL en > T en
- centralize the message resolving logic in helper methods in LocaleUtil and use it for all themes, add unit tests in LocaleUtilTest
- add basic integration tests to check whether realm localization can be used in all supported contexts:
- Account UI V2: org.keycloak.testsuite.ui.account2.InternationalizationTest
- Login theme: LoginPageTest
- Email theme: EmailTest
- deprecate the param useRealmDefaultLocaleFallback=true of endpoint /admin/realms/{realm}/localization/{locale}, because it does not resolve fallbacks as expected and is no longer used in admin-ui v2
- fix locale selection in DefaultLocaleSelectorProvider that a supported region (like "de-CH") will no longer selected instead of a supported language (like "de"), when just the language is requested, add corresponding unit tests
- improvements regarding message resolving in Admin UI V2:
- add cypress test i18n_test.spec.ts, which checks the fallback implementation
- log a warning instead of an error, when messages for some languages/namespaces cannot be loaded (the page will probably work with fallbacks in that case)
Closes #15845
|
||
|---|---|---|
| .. | ||
| cypress | ||
| maven-resources | ||
| public | ||
| src | ||
| cypress.config.mjs | ||
| index.html | ||
| package.json | ||
| pom.xml | ||
| README.md | ||
| tsconfig.json | ||
| tsconfig.node.json | ||
| vite.config.ts | ||
| vitest.setup.ts | ||
Keycloak Admin UI
This project is the next generation of the Keycloak Administration UI. It is written with React and PatternFly 4 and uses Vite and Cypress.
Development
Prerequisites
Make sure that you have Node.js version 18 (or later) installed on your system. If you do not have Node.js installed we recommend using Node Version Manager to install it.
You can find out which version of Node.js you are using by running the following command:
node --version
In order to run the Keycloak server you will also have to install the Java Development Kit (JDK). We recommend that you use the same version of the JDK as required by the Keycloak server.
Running the Keycloak server
See the instructions in the Keycloak server app.
Running the development server
Now that the Keycloak sever is running it's time to run the development server for the Admin UI. This server is used to build the Admin UI in a manner that it can be iterated on quickly in a browser, using features such as Hot Module Replacement (HMR) and Fast Refresh.
To start the development server run the following command:
pnpm run dev
Once the process of optimization is done your browser will automatically open your local host on port 8080. From here you will be redirected to the Keycloak server to authenticate, which you can do with the default username and password (admin).
You can now start making changes to the source code, and they will be reflected in your browser.
Building as a Keycloak theme
If you want to build the application using Maven and produce a JAR that can be installed directly into Keycloak, check out the Keycloak theme documentation.
Linting
Every time you create a commit it should be automatically linted and formatted for you. It is also possible to trigger the linting manually:
pnpm run lint
Integration testing with Cypress
This repository contains integration tests developed with the Cypress framework.
Prerequisites
Ensure the Keycloak and development server are running as outlined previously in this document.
Running the tests
You can run the tests using the interactive graphical user interface using the following command:
pnpm run cy:open
Alternatively the tests can also run headless as follows:
pnpm run cy:run
For more information about the Cypress command-line interface consult the documentation.
Project Structure
You can find information about the project structure in the official Cypress documentation. Read more about how to write tests