3253de73ec
* web: Add InvalidationFlow to Radius Provider dialogues
## What
- Bugfix: adds the InvalidationFlow to the Radius Provider dialogues
- Repairs: `{"invalidation_flow":["This field is required."]}` message, which was *not* propagated
to the Notification.
- Nitpick: Pretties `?foo=${true}` expressions: `s/\?([^=]+)=\$\{true\}/\1/`
## Note
Yes, I know I'm going to have to do more magic when we harmonize the forms, and no, I didn't add the
Property Mappings to the wizard, and yes, I know I'm going to have pain with the *new* version of
the wizard. But this is a serious bug; you can't make Radius servers with *either* of the current
dialogues at the moment.
* This (temporary) change is needed to prevent the unit tests from failing.
\# What
\# Why
\# How
\# Designs
\# Test Steps
\# Other Notes
* Revert "This (temporary) change is needed to prevent the unit tests from failing."
This reverts commit dddde09be5.
* web: Update to OpenAPI 7.11.
This commit updates our Makefile to generate the Typescript api using OpenAPI 7.11, and updates
names (mostly of enum targets) in our product to correspond to the changes in how OpenAPI generates
enum source names.
1. Replaced `ProviderModelEnum.` (note terminal period) with `ProviderModelEnum.AuthentikProvider`.
For example:
```
- ProviderModelEnum.SamlSamlprovider
+ ProviderModelEnum.AuthentikProvidersSamlSamlprovider
```
2. Replaced `RbacPermissionsAssignedByUsersListModelEnum.` (note terminal period) with
`RbacPermissionsAssignedByUsersListModelEnum.Authentik`. For example:
```
- RbacPermissionsAssignedByUsersListModelEnum.ProvidersLdapLdapprovider.toString(),
+ RbacPermissionsAssignedByUsersListModelEnum.AuthentikProvidersLdapLdapprovider.toString(),
```
3. Replaced `SyncObjectModelEnum.` (note terminal period) with
`SyncObjectModelEnum.AuthentikCoreModels`. For example:
```
- model=${SyncObjectModelEnum.Group}
+ model=${SyncObjectModelEnum.AuthentikCoreModelsGroup}
```
4. Replaced `SignatureAlgorithmEnum._` (note terminal symbols) with
`SignatureAlgorithmEnum.HttpWwwW3Org`. For example:
```
- ["ECDSA-SHA256", SignatureAlgorithmEnum._200104XmldsigMoreecdsaSha256],
+ ["ECDSA-SHA256", SignatureAlgorithmEnum.HttpWwwW3Org200104XmldsigMoreecdsaSha256],
```
5. Replaced `DigestAlgorithmEnum._` (note terminal symbols) with `DigestAlgorithmEnum.HttpWwwW3Org`.
For example:
```
- ["SHA256", DigestAlgorithmEnum._200104Xmlencsha256, true],
+ ["SHA256", DigestAlgorithmEnum.HttpWwwW3Org200104Xmlencsha256, true],
```
6. Replaced `NameIdPolicyEnum._` (note terminal symbols) with
`NameIdPolicyEnum.UrnOasisNamesTcSaml`. This one is trickier than the others: If you look
closely, you'll see that how OpenAPI generates the names has changed, with `nameid` now being
`Nameid`, and `FormatemailAddress` now being `FormatEmailAddress`.
```
- value=${NameIdPolicyEnum._11nameidFormatemailAddress}
+ value=${NameIdPolicyEnum.UrnOasisNamesTcSaml11NameidFormatEmailAddress}
```
# How
After determining how the enum prefixes had changed, I just ran six of these, testing after each
step to ensure that `npm run lint:types` had fewer errors than the previous run, until the product
built without type errors.
``` sh
$ perl -pi.bak -e 's/DigestAlgorithmEnum\._/DigestAlgorithmEnum.HttpWwwW3Org/' $(rg -l 'DigestAlgorithmEnum\.' src/)
```
# Testing
You can validate that these items have changed by finding the prefixes in the source code and
assuring yourself that every option, checkbox, or radio associated with them is populated correctly.
# User documentation changes required.
None.
# Developer documentation changes required.
None.
290 lines
9.0 KiB
Makefile
290 lines
9.0 KiB
Makefile
.PHONY: gen dev-reset all clean test web website
|
||
|
||
.SHELLFLAGS += ${SHELLFLAGS} -e
|
||
PWD = $(shell pwd)
|
||
UID = $(shell id -u)
|
||
GID = $(shell id -g)
|
||
NPM_VERSION = $(shell python -m scripts.npm_version)
|
||
PY_SOURCES = authentik tests scripts lifecycle .github
|
||
DOCKER_IMAGE ?= "authentik:test"
|
||
|
||
GEN_API_TS = "gen-ts-api"
|
||
GEN_API_PY = "gen-py-api"
|
||
GEN_API_GO = "gen-go-api"
|
||
|
||
pg_user := $(shell python -m authentik.lib.config postgresql.user 2>/dev/null)
|
||
pg_host := $(shell python -m authentik.lib.config postgresql.host 2>/dev/null)
|
||
pg_name := $(shell python -m authentik.lib.config postgresql.name 2>/dev/null)
|
||
|
||
CODESPELL_ARGS = -D - -D .github/codespell-dictionary.txt \
|
||
-I .github/codespell-words.txt \
|
||
-S 'web/src/locales/**' \
|
||
-S 'website/docs/developer-docs/api/reference/**' \
|
||
authentik \
|
||
internal \
|
||
cmd \
|
||
web/src \
|
||
website/src \
|
||
website/blog \
|
||
website/docs \
|
||
website/integrations \
|
||
website/src
|
||
|
||
all: lint-fix lint test gen web ## Lint, build, and test everything
|
||
|
||
HELP_WIDTH := $(shell grep -h '^[a-z][^ ]*:.*\#\#' $(MAKEFILE_LIST) 2>/dev/null | \
|
||
cut -d':' -f1 | awk '{printf "%d\n", length}' | sort -rn | head -1)
|
||
|
||
help: ## Show this help
|
||
@echo "\nSpecify a command. The choices are:\n"
|
||
@grep -Eh '^[0-9a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | \
|
||
awk 'BEGIN {FS = ":.*?## "}; {printf " \033[0;36m%-$(HELP_WIDTH)s \033[m %s\n", $$1, $$2}' | \
|
||
sort
|
||
@echo ""
|
||
|
||
go-test:
|
||
go test -timeout 0 -v -race -cover ./...
|
||
|
||
test-docker: ## Run all tests in a docker-compose
|
||
echo "PG_PASS=$(shell openssl rand 32 | base64 -w 0)" >> .env
|
||
echo "AUTHENTIK_SECRET_KEY=$(shell openssl rand 32 | base64 -w 0)" >> .env
|
||
docker compose pull -q
|
||
docker compose up --no-start
|
||
docker compose start postgresql redis
|
||
docker compose run -u root server test-all
|
||
rm -f .env
|
||
|
||
test: ## Run the server tests and produce a coverage report (locally)
|
||
coverage run manage.py test --keepdb authentik
|
||
coverage html
|
||
coverage report
|
||
|
||
lint-fix: lint-codespell ## Lint and automatically fix errors in the python source code. Reports spelling errors.
|
||
black $(PY_SOURCES)
|
||
ruff check --fix $(PY_SOURCES)
|
||
|
||
lint-codespell: ## Reports spelling errors.
|
||
codespell -w $(CODESPELL_ARGS)
|
||
|
||
lint: ## Lint the python and golang sources
|
||
bandit -r $(PY_SOURCES) -x web/node_modules -x tests/wdio/node_modules -x website/node_modules
|
||
golangci-lint run -v
|
||
|
||
core-install:
|
||
poetry install
|
||
|
||
migrate: ## Run the Authentik Django server's migrations
|
||
python -m lifecycle.migrate
|
||
|
||
i18n-extract: core-i18n-extract web-i18n-extract ## Extract strings that require translation into files to send to a translation service
|
||
|
||
aws-cfn:
|
||
cd lifecycle/aws && npm run aws-cfn
|
||
|
||
core-i18n-extract:
|
||
ak makemessages \
|
||
--add-location file \
|
||
--no-obsolete \
|
||
--ignore web \
|
||
--ignore internal \
|
||
--ignore ${GEN_API_TS} \
|
||
--ignore ${GEN_API_GO} \
|
||
--ignore website \
|
||
-l en
|
||
|
||
install: web-install website-install core-install ## Install all requires dependencies for `web`, `website` and `core`
|
||
|
||
dev-drop-db:
|
||
dropdb -U ${pg_user} -h ${pg_host} ${pg_name}
|
||
# Also remove the test-db if it exists
|
||
dropdb -U ${pg_user} -h ${pg_host} test_${pg_name} || true
|
||
redis-cli -n 0 flushall
|
||
|
||
dev-create-db:
|
||
createdb -U ${pg_user} -h ${pg_host} ${pg_name}
|
||
|
||
dev-reset: dev-drop-db dev-create-db migrate ## Drop and restore the Authentik PostgreSQL instance to a "fresh install" state.
|
||
|
||
#########################
|
||
## API Schema
|
||
#########################
|
||
|
||
gen-build: ## Extract the schema from the database
|
||
AUTHENTIK_DEBUG=true \
|
||
AUTHENTIK_TENANTS__ENABLED=true \
|
||
AUTHENTIK_OUTPOSTS__DISABLE_EMBEDDED_OUTPOST=true \
|
||
ak make_blueprint_schema > blueprints/schema.json
|
||
AUTHENTIK_DEBUG=true \
|
||
AUTHENTIK_TENANTS__ENABLED=true \
|
||
AUTHENTIK_OUTPOSTS__DISABLE_EMBEDDED_OUTPOST=true \
|
||
ak spectacular --file schema.yml
|
||
|
||
gen-changelog: ## (Release) generate the changelog based from the commits since the last tag
|
||
git log --pretty=format:" - %s" $(shell git describe --tags $(shell git rev-list --tags --max-count=1))...$(shell git branch --show-current) | sort > changelog.md
|
||
npx prettier --write changelog.md
|
||
|
||
gen-diff: ## (Release) generate the changelog diff between the current schema and the last tag
|
||
git show $(shell git describe --tags $(shell git rev-list --tags --max-count=1)):schema.yml > old_schema.yml
|
||
docker run \
|
||
--rm -v ${PWD}:/local \
|
||
--user ${UID}:${GID} \
|
||
docker.io/openapitools/openapi-diff:2.1.0-beta.8 \
|
||
--markdown /local/diff.md \
|
||
/local/old_schema.yml /local/schema.yml
|
||
rm old_schema.yml
|
||
sed -i 's/{/{/g' diff.md
|
||
sed -i 's/}/}/g' diff.md
|
||
npx prettier --write diff.md
|
||
|
||
gen-clean-ts: ## Remove generated API client for Typescript
|
||
rm -rf ./${GEN_API_TS}/
|
||
rm -rf ./web/node_modules/@goauthentik/api/
|
||
|
||
gen-clean-go: ## Remove generated API client for Go
|
||
rm -rf ./${GEN_API_GO}/
|
||
|
||
gen-clean-py: ## Remove generated API client for Python
|
||
rm -rf ./${GEN_API_PY}/
|
||
|
||
gen-clean: gen-clean-ts gen-clean-go gen-clean-py ## Remove generated API clients
|
||
|
||
gen-client-ts: gen-clean-ts ## Build and install the authentik API for Typescript into the authentik UI Application
|
||
docker run \
|
||
--rm -v ${PWD}:/local \
|
||
--user ${UID}:${GID} \
|
||
docker.io/openapitools/openapi-generator-cli:v7.11.0 generate \
|
||
-i /local/schema.yml \
|
||
-g typescript-fetch \
|
||
-o /local/${GEN_API_TS} \
|
||
-c /local/scripts/api-ts-config.yaml \
|
||
--additional-properties=npmVersion=${NPM_VERSION} \
|
||
--git-repo-id authentik \
|
||
--git-user-id goauthentik
|
||
mkdir -p web/node_modules/@goauthentik/api
|
||
cd ./${GEN_API_TS} && npm i
|
||
\cp -rf ./${GEN_API_TS}/* web/node_modules/@goauthentik/api
|
||
|
||
gen-client-py: gen-clean-py ## Build and install the authentik API for Python
|
||
docker run \
|
||
--rm -v ${PWD}:/local \
|
||
--user ${UID}:${GID} \
|
||
docker.io/openapitools/openapi-generator-cli:v7.4.0 generate \
|
||
-i /local/schema.yml \
|
||
-g python \
|
||
-o /local/${GEN_API_PY} \
|
||
-c /local/scripts/api-py-config.yaml \
|
||
--additional-properties=packageVersion=${NPM_VERSION} \
|
||
--git-repo-id authentik \
|
||
--git-user-id goauthentik
|
||
pip install ./${GEN_API_PY}
|
||
|
||
gen-client-go: gen-clean-go ## Build and install the authentik API for Golang
|
||
mkdir -p ./${GEN_API_GO} ./${GEN_API_GO}/templates
|
||
wget https://raw.githubusercontent.com/goauthentik/client-go/main/config.yaml -O ./${GEN_API_GO}/config.yaml
|
||
wget https://raw.githubusercontent.com/goauthentik/client-go/main/templates/README.mustache -O ./${GEN_API_GO}/templates/README.mustache
|
||
wget https://raw.githubusercontent.com/goauthentik/client-go/main/templates/go.mod.mustache -O ./${GEN_API_GO}/templates/go.mod.mustache
|
||
cp schema.yml ./${GEN_API_GO}/
|
||
docker run \
|
||
--rm -v ${PWD}/${GEN_API_GO}:/local \
|
||
--user ${UID}:${GID} \
|
||
docker.io/openapitools/openapi-generator-cli:v6.5.0 generate \
|
||
-i /local/schema.yml \
|
||
-g go \
|
||
-o /local/ \
|
||
-c /local/config.yaml
|
||
go mod edit -replace goauthentik.io/api/v3=./${GEN_API_GO}
|
||
rm -rf ./${GEN_API_GO}/config.yaml ./${GEN_API_GO}/templates/
|
||
|
||
gen-dev-config: ## Generate a local development config file
|
||
python -m scripts.generate_config
|
||
|
||
gen: gen-build gen-client-ts
|
||
|
||
#########################
|
||
## Web
|
||
#########################
|
||
|
||
web-build: web-install ## Build the Authentik UI
|
||
cd web && npm run build
|
||
|
||
web: web-lint-fix web-lint web-check-compile ## Automatically fix formatting issues in the Authentik UI source code, lint the code, and compile it
|
||
|
||
web-install: ## Install the necessary libraries to build the Authentik UI
|
||
cd web && npm ci
|
||
|
||
web-test: ## Run tests for the Authentik UI
|
||
cd web && npm run test
|
||
|
||
web-watch: ## Build and watch the Authentik UI for changes, updating automatically
|
||
rm -rf web/dist/
|
||
mkdir web/dist/
|
||
touch web/dist/.gitkeep
|
||
cd web && npm run watch
|
||
|
||
web-storybook-watch: ## Build and run the storybook documentation server
|
||
cd web && npm run storybook
|
||
|
||
web-lint-fix:
|
||
cd web && npm run prettier
|
||
|
||
web-lint:
|
||
cd web && npm run lint
|
||
cd web && npm run lit-analyse
|
||
|
||
web-check-compile:
|
||
cd web && npm run tsc
|
||
|
||
web-i18n-extract:
|
||
cd web && npm run extract-locales
|
||
|
||
#########################
|
||
## Website
|
||
#########################
|
||
|
||
website: website-lint-fix website-build ## Automatically fix formatting issues in the Authentik website/docs source code, lint the code, and compile it
|
||
|
||
website-install:
|
||
cd website && npm ci
|
||
|
||
website-lint-fix: lint-codespell
|
||
cd website && npm run prettier
|
||
|
||
website-build:
|
||
cd website && npm run build
|
||
|
||
website-watch: ## Build and watch the documentation website, updating automatically
|
||
cd website && npm run watch
|
||
|
||
#########################
|
||
## Docker
|
||
#########################
|
||
|
||
docker: ## Build a docker image of the current source tree
|
||
mkdir -p ${GEN_API_TS}
|
||
DOCKER_BUILDKIT=1 docker build . --progress plain --tag ${DOCKER_IMAGE}
|
||
|
||
#########################
|
||
## CI
|
||
#########################
|
||
# These targets are use by GitHub actions to allow usage of matrix
|
||
# which makes the YAML File a lot smaller
|
||
|
||
ci--meta-debug:
|
||
python -V
|
||
node --version
|
||
|
||
ci-black: ci--meta-debug
|
||
black --check $(PY_SOURCES)
|
||
|
||
ci-ruff: ci--meta-debug
|
||
ruff check $(PY_SOURCES)
|
||
|
||
ci-codespell: ci--meta-debug
|
||
codespell $(CODESPELL_ARGS) -s
|
||
|
||
ci-bandit: ci--meta-debug
|
||
bandit -r $(PY_SOURCES)
|
||
|
||
ci-pending-migrations: ci--meta-debug
|
||
ak makemigrations --check
|