Terraform Provider Development Program - Initial Review

[cgriggs01]

Hey Team, 👋 My name is Chris, I'm a member of the Partner team @ HashiCorp.

I’ve taken a look at the provider here and would like to say great work so far! I do have feedback outlined below that I’d like to see addressed before we move on to the next steps. I’m opening this issues as a sort of checklist for tracking items and discussion. The review was done on the master branch at git commit 10ab4b3

• [x] All the acceptance tests are passing except for the CustomDomain test. It just appears to be failing due to that fact that this is a free tier test account. Is this the case or should all tests be passing?

• [x] Each Terraform provider must have its own terraform.io website documentation that should reside under a website/ directory. There should be a page for each resource and data source as well as an index page for the provider. Along with with must be a ruby layout file to represent the side bar directory.

• [x] There are a number of files that must be added in order for the provider to function in the Terraform native ecosystem.

  • The GNUmakefile is pretty standard across all Terraform providers, feel free to copy the NULL provider makefile, you will just have to update the variable on line 4 to PKG_NAME=auth0 and update to use ‘dep’
  • There are four bash scripts in a scripts/ that are used in different processes of testing and release, these can all be copied from the NULL provider
  • Each Terraform provider must have a CHANGELOG that is updated during reach release. Since the changeling is updated by a bot during the release it must be in a certain format. With the AWS provider changelog as an example, the version of the nexted release should be tagged as “(Unreleased)” and will then be updated with a date by the release-bot.
  • All providers in the terraform-providers/ GitHub org have a TravisCI check run on each PR that is opened. Can you please update your .travis.yaml file to make the standard configuration

• [x] You currently have a MIT License on the provider, would you be able to change that to a MPL2 which is the standard across all Terraform providers.

Let me know if you have any questions. -Chris

[alexkappa]

Hi Chris,

Thanks for your review!

I have some answers to your questions and will create PRs to address the points you mention.

All the acceptance tests are passing except for the CustomDomain test

This depends on the credentials you used to run the tests. In our CI environment, I'm using our company's account which is paid and allows us to run the Custom Domain tests as well.

The GNUmakefile

We currently use a Makefile which is reccommended by GNU unless its intended specifically for GNU make. is it important this be a GNUmakefile?

There are four bash scripts in a scripts

Will make a PR to add these scripts.

Each Terraform provider must have a CHANGELOG

I think it might be difficult to maintain this format easily with our build bot (goreleaser). I might follow the approach done by the AWS provider to manually track the changes.

All providers in the terraform-providers/ GitHub org have a TravisCI check

Is it important that the CI is done by TravisCI? We are more experienced using Wercker but if it's needed I can look into porting it to TravisCI.

You currently have a MIT License

A PR is already in to switch to MPL2.0

Cheers, Alex

[cgriggs01]

Hey Alex,

Thanks for the responses and questions.

• As for the CustomDomain test, do you have any idea they this test continues to fail when I run them from my local machine?

• We have standardized on GNUmakefile because there have been some issues running Makefile has had issue running on Windows machines.

The Changelog is required for the release from our side. Once the provider completes the review and testing certification we'll release the provider under the terraform-providers/ GitHub organization where our bots will help in the build and release.

Best, Chris

[alexkappa]

Hi Chris,

About the CustomDomain, it really depends on your Auth0 account. If the credentials you used to run the test are of a free account, the Auth0 API will respond with 403 error code as you are not allowed access to that resource:

This feature is not available for free plans. To configure a custom domain you have to upgrade your account to any paid plan

To test it locally, you must have credentials from a paid account. I have reached out to Auth0 if they could sponsor this project by means of a paid account, but the most I managed to get is a free upgrade to our companies staging account.

We have standardized on GNUmakefile

Okay, the change shouldn't be too disruptive so I'll rename the file.

The Changelog is required for the release

Of course, I understand. What I mentioned is that I will opt for a manual strategy of updating the changelog in order to have more control over the formatting. Our release tool won't be able to cope with the formatting constraints.

Do you have any thoughts on my question regarding TravisCI?

Best, Alex

[alexkappa]

Hi @cgriggs01, I believe most of the items in your feedback have been addressed. Would you mind having another look and let me know how we can continue?

With regards to the documentation, the work is under way and the skeleton is there but we haven't documented all the resources yet. We also had some trouble with the website, please see this issue.

Thanks! Alex

[github-actions[bot]]

This issue is stale because it has been open 30 days with no activity. Stale issues will be closed after 5 days if no action is taken. If you think this issue should not be closed, remove the stale label.

[alexkappa]

@cgriggs01 would be nice to have another look at this. The tests now all pass since Auth0 has granted me a free open source account in which we can test custom domains properly.

[apricote]

There is now a copied repository at terraform-providers/terraform-provider-auth0. Its also included in the official documentation.

[alexkappa]

Hi @apricote. Was it not possible to fork, or transfer the repository in order to preserve issues or pull requests that are open?

Also, since the release process is handled by hashicorp staff, I removed the automation I had in place to make releases. I was told I would be invited to a slack channel where I could coordinate with hashicorp on releasing. Might you be able to help me out with that?

Cheers, Alex

[apricote]

Hi @alexkappa,

I am not affiliated with Hashicorp in any way. I just found the new repository and thought that it is relevant to this ticket.

You will have to ask Chris (@cgriggs01) about the slack channel and any processes.

Best, Julian

[alexkappa]

My apologies, I was under the impression that you were from the hashicorp folks.. 😅

I have sent Chris an email asking about this.

On Wed, 19 Feb 2020 at 18:20, Julian Tölle notifications@github.com wrote:

Hi @alexkappa https://github.com/alexkappa,

I am not affiliated with Hashicorp in any way. I just found the new repository and thought that it is relevant to this ticket.

You will have to ask Chris (@cgriggs01 https://github.com/cgriggs01) about the slack channel and any processes.

Best, Julian

— You are receiving this because you were mentioned.

Reply to this email directly, view it on GitHub https://github.com/alexkappa/terraform-provider-auth0/issues/70?email_source=notifications&email_token=AAJF677MXHMYVREMUQRWFLTRDVS5RA5CNFSM4GOSMJR2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEMIVIHQ#issuecomment-588338206, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAJF677PCZOLLWLNDD6CBFLRDVS5RANCNFSM4GOSMJRQ .

[bishtawi]

@alexkappa Did you ever get in touch with the Hashicorp team about that cloned repo? Should we be switching over? I noticed this repo is at version v0.5.2 but the copied repo is at v0.6.0 but that copied repo doesnt have a changelog for v0.6.0, doesnt have a v0.5.2 release, and its v0.5.1 changelog doesnt match this repo's v0.5.1 changelog.

[alexkappa]

I will be maintaining both for the foreseeable future so feel free to use the one that suits you best.

I managed to get a release through Hashicorp (v0.6.0). I will be releasing it on this repo as well but haven't gotten to it yet.

Its a process, and I will do my best to make sure that the community doesn't suffer from the transition, but its not very easy for me as now I have two places to deal with issues and pull requests. Please bear with me while I figure this out.

On Wed, 4 Mar 2020 at 20:53, Stephen notifications@github.com wrote:

@alexkappa https://github.com/alexkappa Did you ever get in touch with the Hashicorp team about that cloned repo? Should we be switching over? I noticed this repo is at version v0.5.2 but the copied repo is at v0.6.0 but that copied repo doesnt have a changelog for v0.6.0, doesnt have a v0.5.2 release, and its v0.5.1 changelog doesnt match this repo's v0.5.1 changelog.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/alexkappa/terraform-provider-auth0/issues/70?email_source=notifications&email_token=AAJF673YBNC75SWKBHWJMKDRF2WTDA5CNFSM4GOSMJR2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOENZ5YPI#issuecomment-594795581, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAJF67YRUT2BAHLIW3AGQYTRF2WTDANCNFSM4GOSMJRQ .

[scottx611x]

@alexkappa Would targeting one of the two repos in question make your life easier moving forward and/or in the interim?

[alexkappa]

Yes, the current repo has most of the history so its best when triaging issues. So if you can, please prefer to do so here.

[xens]

Hi @alexkappa I'm wondering what's the status on that one, looks like that the hashicorp repo is now archived https://github.com/terraform-providers/terraform-provider-auth0 and lot sof people will probably be stuck on 0.14 as it's the latest version published there. Anything we can do to help on that topic ? (doc ?)

[sergiught]

Hello everyone, it seems that this issue has been already solved and as such I'll be closing it down over here. In case there are new updates please feel free to reopen it.