Adding multi-provider draft and enabling dev OAuth2 provider #25

danielbdias · 2020-08-19T18:24:32Z

Motivation and Context

The first time that you run Will.IAM you could have problems to setup a valid OAuth2 provider. It is implicit that you need to follow these steps and make a setup to enable Google OAuth2 to execute tests in development.

Description

To help with that I've changed the API to choose another OAuth2 provider from config and added a provider that calls a test OAuth2 server.

In future we can modify this dev server to allow a developer to simulate interactions with many users at same time using another systems that use Will.IAM to manage permissions.

How Has This Been Tested?

Start Will.IAM auxiliary services using make compose-up. This command will start three docker containers: database, oauth2-server and Will.IAM itself.
a. (extra) If it is your first time running Will.IAM, make be sure to run make db/setup first to create Will.IAM database;
Assuming a Referer link as http://localhost:3000, just access the following link on a browser:

http://localhost:4040/sso/auth/do?referer=http%3A%2F%2Flocalhost%3A3000

It should trigger the OAuth2 authentication procedure (very similar to this explanation), returning to the referer link at the end.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

My code has tests.
My change requires a change to the documentation.
I have updated the documentation accordingly.

danielbdias · 2020-08-20T18:57:18Z

Makefile

@@ -32,7 +32,11 @@ docker/build:

 .PHONY: run
 run:
-	@reflex -c reflex.conf -- sh -c ./bin/Will.IAM start-api
+	make build && ./bin/Will.IAM start-api --host=localhost -v3


Without adding --host=localhost command, every time we compile and run Will.IAM we receive a MacOS Firewall message box asking us to allow connections to this app.
Telling that you are using localhost avoid it on development.

danielbdias · 2020-08-20T18:59:43Z

docker-compose.yml

@@ -1,5 +1,10 @@
 version: '2'
 services:
+  oauth2-server:


To help us with OAuth2 I'm using oauth2-mock-server that mocks some requests to use.

danielbdias · 2020-08-20T19:02:09Z

utils/logger.go

 	switch verbosity {
 	case 0:
-		log.Level = logrus.InfoLevel
+		log.Level = logrus.ErrorLevel


I think that the verbosity code was added here by mistake. I added this hierarchy to make more sense to devs who want to use this option.

danielbdias · 2020-08-20T19:42:59Z

oauth2/mock.go

+)
+
+// ProviderBlankMock is a Provider mock will all dummy implementations
+type ProviderBlankMock struct {


This provider is used only as a mock to some unit/integration tests on Will.IAM, so I've moved it untouched to another file.

rodopoulos

Besides the above, LGTM!

rodopoulos · 2020-08-21T14:48:56Z

Makefile

@@ -32,7 +32,11 @@ docker/build:

 .PHONY: run
 run:
-	@reflex -c reflex.conf -- sh -c ./bin/Will.IAM start-api
+	make build && ./bin/Will.IAM start-api --host=localhost -v3


Instead of using make command inside each other, use target dependency:

Suggested change

make build && ./bin/Will.IAM start-api --host=localhost -v3

run: build

./bin/Will.IAM start-api --host=localhost -v3

rodopoulos · 2020-08-21T14:54:10Z

Makefile

+compose-up:
+	@mkdir -p docker_data && docker-compose up -d
+	@until docker exec $(pg_docker_image) pg_isready; do echo 'Waiting Postgres...' && sleep 1; done
+	@sleep 2


Why having this?

Because the other similar command only start the database container postgres, skipping the new oauth2-server container.
Thinking now, to simplify this logic I'll an parameter here and edit db/up to send a container parameter.

Hm, having a better look, I see that the docker-compose only starts dependencies. Why not starting Will.IAM as well. An upside on this approach is using compose's depends_on feature.

With that, you can declare Will.IAM dependencies and having it wait until they are fully initialized. You only need to provide a healthcheck operations for each dependency, which should be pretty simple.

This is only a suggestion, if you'd like to address this in another PR, feel free to do it.

oauth2/dev.go

README.md

Co-authored-by: Felipe Rodopoulos <felipekss@gmail.com>

rodopoulos · 2020-08-24T15:43:17Z

Makefile

-	@mkdir -p docker_data && docker-compose up -d postgres
-	@until docker exec $(pg_docker_image) pg_isready; do echo 'Waiting Postgres...' && sleep 1; done
-	@sleep 2
+	make compose-up container=postgres


I don't think this approach will work if you need to wait for the dependency to be ready. The end of db/up target is not a guarantee that Postgres is accepting connections on the container.

…AM into features/dev-provider

rodopoulos

Everything good!

Daniel Dias added 5 commits August 18, 2020 15:22

Added config to enable auth with mock OAuth2 server

dd1cc8c

Adding mock OAuth2 server

ca4f9f0

Adding dev oauth2 provider

2cb7099

Adding test to logger

911ae54

Fixing minor redirect bug on ExchangeCode

594cf71

danielbdias commented Aug 20, 2020

View reviewed changes

Updating README

07614d8

danielbdias commented Aug 20, 2020

View reviewed changes

danielbdias marked this pull request as ready for review August 20, 2020 19:43

Enabling token flow

f0b9c87

rodopoulos reviewed Aug 21, 2020

View reviewed changes

Daniel Dias and others added 3 commits August 21, 2020 16:36

Adding PR suggestions

252ef47

Changing db/up script

14f5ec0

Update README.md

739c574

Co-authored-by: Felipe Rodopoulos <felipekss@gmail.com>

rodopoulos reviewed Aug 24, 2020

View reviewed changes

Daniel Dias added 5 commits August 24, 2020 14:59

Improved dependency checking between docker containers

4cc3cc3

Merge branch 'features/dev-provider' of github.com:danielbdias/Will.I…

71a05dd

…AM into features/dev-provider

Changing container start commands to use healthcheck

edb3e95

Adding PR suggestions to healthcheck

6c33443

Updating Readme

7e07206

rodopoulos approved these changes Aug 25, 2020

View reviewed changes

danielbdias merged commit c54320b into topfreegames:master Sep 1, 2020

danielbdias deleted the features/dev-provider branch September 1, 2020 17:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding multi-provider draft and enabling dev OAuth2 provider #25

Adding multi-provider draft and enabling dev OAuth2 provider #25

danielbdias commented Aug 19, 2020 •

edited

danielbdias Aug 20, 2020

danielbdias Aug 20, 2020 •

edited

danielbdias Aug 20, 2020

danielbdias Aug 20, 2020

rodopoulos left a comment

rodopoulos Aug 21, 2020

rodopoulos Aug 21, 2020

danielbdias Aug 21, 2020

rodopoulos Aug 24, 2020

rodopoulos Aug 24, 2020

rodopoulos left a comment

	make build && ./bin/Will.IAM start-api --host=localhost -v3
	run: build
	./bin/Will.IAM start-api --host=localhost -v3

Adding multi-provider draft and enabling dev OAuth2 provider #25

Adding multi-provider draft and enabling dev OAuth2 provider #25

Conversation

danielbdias commented Aug 19, 2020 • edited

Motivation and Context

Description

How Has This Been Tested?

Types of changes

Checklist:

Choose a reason for hiding this comment

danielbdias Aug 20, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rodopoulos left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rodopoulos left a comment

Choose a reason for hiding this comment

danielbdias commented Aug 19, 2020 •

edited

danielbdias Aug 20, 2020 •

edited