No description
Find a file
2021-07-07 17:04:11 +02:00
.github Fix Storybook server and update to latest version 2021-07-05 15:33:54 +02:00
.storybook Use WebPack 5 for Storybook builds 2021-07-07 17:04:11 +02:00
cypress Instantly paste large resource files in Cypress tests 2021-07-06 16:29:56 +02:00
public fixed issue 2021-06-23 13:16:10 +02:00
src Convert MapperDialog test to use React Testing Library 2021-07-07 14:50:06 +02:00
types Extend tsconfig from Snowpack and fix type errors 2021-05-18 16:50:35 +02:00
.dockerignore add Docker and docker-compose (#456) 2021-03-23 11:07:46 +01:00
.eslintrc.json First page within Group section (#108) 2020-09-28 11:58:03 -04:00
.gitignore Fix Storybook server and update to latest version 2021-07-05 15:33:54 +02:00
.prettierrc.json added initial version of the "help system" (#26) 2020-09-02 09:51:42 +02:00
babel.config.json fixed build by changing it to webpack (#50) 2020-09-01 08:21:47 -04:00
CODE_OF_CONDUCT.md Added code of conduct to project. (#150) 2020-10-07 11:14:55 -04:00
CODING_GUIDELINES.md Added coding standards to the project. (#139) 2020-10-06 17:42:32 -04:00
cypress.json change default command timeout to 10 sec 2021-06-09 09:24:03 -04:00
docker-compose.yml add Docker and docker-compose (#456) 2021-03-23 11:07:46 +01:00
Dockerfile Update to latest version of NodeJS (#558) 2021-04-30 10:43:23 +02:00
Gruntfile.js changed location due to new snowpack postcss plugin 2021-06-07 09:18:50 +02:00
import.js removed cypress init spec in favor of node script (#340) 2021-01-28 16:04:48 +01:00
jest.config.ts Drop snapshot tests in Jest 2021-07-07 10:57:35 +02:00
jest.setup.ts Remove Enzyme from testing suite 2021-07-07 15:40:50 +02:00
LICENSE Initial commit 2020-07-27 14:40:12 -04:00
nginx-default.conf add Docker and docker-compose (#456) 2021-03-23 11:07:46 +01:00
nginx.conf initial move group dialog (#455) 2021-03-29 07:37:47 -04:00
package.json Use WebPack 5 for Storybook builds 2021-07-07 17:04:11 +02:00
postcss.config.js let post css use all paths (#102) 2020-09-17 11:13:04 -04:00
README.md add Docker and docker-compose (#456) 2021-03-23 11:07:46 +01:00
realm-settings.png fix: added build instructions 2020-08-06 17:11:12 +02:00
security-admin-console-v2-combined.json add Docker and docker-compose (#456) 2021-03-23 11:07:46 +01:00
security-admin-console-v2.json First page within Group section (#108) 2020-09-28 11:58:03 -04:00
snowpack.config.js Allow New Admin Console to run as a WAR on Keycloak server. (#439) 2021-03-18 08:48:14 -04:00
start.js removed cypress init spec in favor of node script (#340) 2021-01-28 16:04:48 +01:00
tsconfig.json Extend tsconfig from Snowpack and fix type errors 2021-05-18 16:50:35 +02:00
yarn.lock Use WebPack 5 for Storybook builds 2021-07-07 17:04:11 +02:00

Keycloak Admin Console V2

This project is the next generation of the Keycloak Administration Console. It is written with React and PatternFly 4.

Development Instructions

For development on this project you will need a running Keycloak server listening on port 8180. You will also need yarn installed on your local machine.

  1. Start keycloak

    • Download and run with one command
      $> ./start.js
      
    • or download Keycloak server from keycloak downloads page unpack and run it like:
      $> cd <unpacked download folder>/bin
      $> standalone -Djboss.socket.binding.port-offset=100
      
  2. Go to the clients section of the existing Keycloak Admin Console and add the client

    • like this: realm settings
    • or click on the "Select file" button and import security-admin-console-v2.json
    • or run $> ./import.js
  3. Install dependencies and run:

    $> yarn
    $> yarn start
    

Build and run through Docker

git checkout git@github.com:keycloak/keycloak-admin-ui.git
cd keycloak-admin-ui
docker-compose build
docker-compose up

You can reach the new admin interface at http://localhost

If your Keycloak instance is not on localhost:8180, create a file .env with the following:

KEYCLOAK_ENDPOINT=https:\/\/remoteinstance.keycloak.com

Additionally there are some nice scripts to format and lint

$> yarn format
$> yarn check-types
$> yarn lint

To switch to a RH-SSO themed version of this console you can run:

$> npx grunt switch-rh-sso

To switch back just do a git checkout public

Keycloak UI Test Suite in Cypress

This repository contains the UI tests for Keycloak developed with Cypress framework

Run the test suite

Prerequisites

via Cypress Test Runner

By using npx:

note: npx is included with npm > v5.2 or can be installed separately.

npx cypress open

After a moment, the Cypress Test Runner will launch:

image

via terminal

By executing:

$(npm bin)/cypress run

...or...

./node_modules/.bin/cypress run

...or... (requires npm@5.2.0 or greater)

npx cypress run

To execute a specific test on a specific browser run:

cypress run --spec "cypress/integration/example-test.spec.js" --browser chrome

note: the complete list of parameters can be found in the official Cypress documentation.

Project Structure

/assets (added to .gitignore)
  /videos - if test fails, the video is stored here
  /screenshots - if test fails, the screenshot is stored here
/cypress
  /fixtures - external pieces of static data that can be used by your tests
  /integration - used for test files (supported filetypes are .js, .jsx, .coffee and .cjsx)
  /plugins
    - index.js - extends Cypress behaviour, custom plugins are imported before every single spec file run
  /support - reusable behaviour
    - commands.js - custom commands
    - index.js - runs before each test file

/cypress.json - Cypress configuration file
/jsconfig.json - Cypress code autocompletion is enabled here

note: More about the project structure in the official Cypress documentation.

License