chore: format using Make (#111)

.circleci/config.yml

@@ -86,7 +86,9 @@ jobs:
             ./.circleci/release_name.bash
             source $BASH_ENV
       - setup_remote_docker
-      - run: docker login --username "$DOCKER_USERNAME" --password "$DOCKER_PASSWORD"
+      - run:
+          docker login --username "$DOCKER_USERNAME" --password
+          "$DOCKER_PASSWORD"
       - run: curl -sL https://git.io/goreleaser | bash
 
   release-changelog:
@@ -96,7 +98,9 @@ jobs:
       - checkout
       - run: gem install github_changelog_generator -v 1.14.3
       - run: sudo npm i -g doctoc
-      - run: github_changelog_generator -u ory -p hydra-maester -o CHANGELOG.md --token $GITHUB_TOKEN
+      - run:
+          github_changelog_generator -u ory -p hydra-maester -o CHANGELOG.md
+          --token $GITHUB_TOKEN
       - run: doctoc CHANGELOG.md
       - run: doctoc README.md
       - run: git config --global user.email "circleci@ory.am"
@@ -106,7 +110,9 @@ jobs:
       - run: |
           git commit -a -m "docs: Incorporates changes from version $(git describe --tags)" || true
       - run: git remote rm origin
-      - run: git remote add origin https://arekkas:$GITHUB_TOKEN@github.com/ory/hydra-maester.git
+      - run:
+          git remote add origin
+          https://arekkas:$GITHUB_TOKEN@github.com/ory/hydra-maester.git
       - run: git push origin HEAD:master || true
 
 workflows:

.github/workflows/cve-scan.yaml

@@ -2,12 +2,12 @@ name: Docker Image Scan
 on:
   push:
     branches:
-      - 'master'
+      - "master"
     tags:
-      - 'v*.*.*'
+      - "v*.*.*"
   pull_request:
     branches:
-      - 'master'
+      - "master"
 
 jobs:
   docker:
@@ -18,7 +18,7 @@ jobs:
       - uses: actions/setup-go@v2
         name: Setup Golang
         with:
-          go-version: '^1.16'
+          go-version: "^1.16"
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v1
       - name: Set up Docker Buildx
@@ -45,8 +45,8 @@ jobs:
         uses: aquasecurity/trivy-action@master
         with:
           image-ref: controller:latest
-          format: 'table'
+          format: "table"
-          exit-code: '42'
+          exit-code: "42"
           ignore-unfixed: true
-          vuln-type: 'os,library'
+          vuln-type: "os,library"
-          severity: 'CRITICAL,HIGH'
+          severity: "CRITICAL,HIGH"

.github/workflows/format.yml

@@ -0,0 +1,17 @@
+name: Format
+
+on:
+  pull_request:
+  push:
+
+jobs:
+  format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v3
+        with:
+          go-version: 1.19
+      - run: make format
+      - name: Indicate formatting issues
+        run: git diff HEAD --exit-code --color

.gitignore

@@ -1,4 +1,3 @@
-
 # Binaries for programs and plugins
 *.exe
 *.exe~
@@ -25,3 +24,5 @@ bin
 
 config/default/manager_image_patch.yaml-e
 /manager
+
+node_modules/

.goreleaser.yml

@@ -27,7 +27,6 @@ snapshot:
 changelog:
   sort: asc
 
-
 dockers:
   - image_templates:
       - "oryd/hydra-maester:v{{ .Major }}"

.prettierignore

@@ -0,0 +1,4 @@
+api/v1alpha1/zz_generated.deepcopy.go
+CHANGELOG.md
+.github/pull_request_template.md
+CONTRIBUTING.md

Makefile

@@ -28,7 +28,7 @@ all: manager
 
 # Run tests
 .PHONY: test
-test: generate fmt vet manifests
+test: generate vet manifests
 	go test ./api/... ./controllers/... ./hydra/... ./helpers/... -coverprofile cover.out
 
 # Start KIND pseudo-cluster
@@ -64,12 +64,12 @@ test-integration:
 
 # Build manager binary
 .PHONY: manager
-manager: generate fmt vet
+manager: generate vet
 	CGO_ENABLED=0 GO111MODULE=on GOOS=linux GOARCH=amd64 go build -a -o manager main.go
 
 # Run against the configured Kubernetes cluster in ~/.kube/config
 .PHONY: run
-run: generate fmt vet
+run: generate vet
 	go run ./main.go --hydra-url ${HYDRA_URL}
 
 # Install CRDs into a cluster
@@ -88,10 +88,10 @@ deploy: manifests
 manifests: controller-gen
 	$(CONTROLLER_GEN) $(CRD_OPTIONS) rbac:roleName=manager-role webhook paths="./..." output:crd:artifacts:config=config/crd/bases
 
-# Run go fmt against code
+# Format the source code
-.PHONY: fmt
+format: node_modules
-fmt:
 	go fmt ./...
+	npm exec -- prettier --write .
 
 # Run go vet against code
 .PHONY: vet
@@ -135,3 +135,7 @@ kubebuilder:
 	curl -sL https://github.com/kubernetes-sigs/kubebuilder/releases/download/v2.3.2/kubebuilder_2.3.2_${OS}_${ARCH}.tar.gz | tar -xz -C /tmp/
 	mv /tmp/kubebuilder_2.3.2_${OS}_${ARCH} ${PWD}/.bin/kubebuilder
 	export PATH=${PATH}:${PWD}/.bin/kubebuilder/bin
+
+node_modules: package-lock.json
+	npm ci
+	touch node_modules

README.md

@@ -15,15 +15,26 @@
 
 ⚠️ ⚠️ ⚠️
 
-> Ory Hydra Maester is developed by the Ory community and is not actively maintained by Ory core maintainers due to lack of resources, time, and knolwedge. As such please be aware that there might be issues with the system. If you have ideas for better testing and development principles please open an issue or PR!
+> Ory Hydra Maester is developed by the Ory community and is not actively
+> maintained by Ory core maintainers due to lack of resources, time, and
+> knolwedge. As such please be aware that there might be issues with the system.
+> If you have ideas for better testing and development principles please open an
+> issue or PR!
 
 ⚠️ ⚠️ ⚠️
 
-This project contains a Kubernetes controller that uses Custom Resources (CR) to manage Hydra Oauth2 clients. ORY Hydra Maester watches for instances of `oauth2clients.hydra.ory.sh/v1alpha1` CR and creates, updates, or deletes corresponding OAuth2 clients by communicating with ORY Hydra's API.
+This project contains a Kubernetes controller that uses Custom Resources (CR) to
+manage Hydra Oauth2 clients. ORY Hydra Maester watches for instances of
+`oauth2clients.hydra.ory.sh/v1alpha1` CR and creates, updates, or deletes
+corresponding OAuth2 clients by communicating with ORY Hydra's API.
 
-Visit Hydra-maester's [chart documentation](https://github.com/ory/k8s/blob/master/docs/helm/hydra-maester.md) and view [sample OAuth2 client resources](config/samples) to learn more about the `oauth2clients.hydra.ory.sh/v1alpha1` CR. 
+Visit Hydra-maester's
+[chart documentation](https://github.com/ory/k8s/blob/master/docs/helm/hydra-maester.md)
+and view [sample OAuth2 client resources](config/samples) to learn more about
+the `oauth2clients.hydra.ory.sh/v1alpha1` CR.
 
-The project is based on [Kubebuilder](https://github.com/kubernetes-sigs/kubebuilder).
+The project is based on
+[Kubebuilder](https://github.com/kubernetes-sigs/kubebuilder).
 
 ## Prerequisites
 
@@ -31,10 +42,12 @@ The project is based on [Kubebuilder](https://github.com/kubernetes-sigs/kubebui
 - make
 - kubectl
 - kustomize
-- [kubebuilder](https://github.com/kubernetes-sigs/kubebuilder) for running tests
+- [kubebuilder](https://github.com/kubernetes-sigs/kubebuilder) for running
+  tests
 - [ginkgo](https://onsi.github.io/ginkgo/) for local integration testing
 - access to K8s environment: minikube or a remote K8s cluster
-- [mockery](https://github.com/vektra/mockery) to generate mocks for testing purposes
+- [mockery](https://github.com/vektra/mockery) to generate mocks for testing
+  purposes
 
 ## Design
 
@@ -44,15 +57,17 @@ Take a look at [Design Readme](./docs/README.md).
 
 - `make test` to run tests
 - `make test-integration` to run integration tests
-- `make install` to generate CRD file from go sources and install it on the cluster
+- `make install` to generate CRD file from go sources and install it on the
+  cluster
 - `export HYDRA_URL={HYDRA_SERVICE_URL} && make run` to run the controller
 
-To deploy the controller, edit the value of the ```--hydra-url``` argument in the [manager.yaml](config/manager/manager.yaml) file and run ```make deploy```.
+To deploy the controller, edit the value of the `--hydra-url` argument in the
+[manager.yaml](config/manager/manager.yaml) file and run `make deploy`.
 
 ### Command-line flags
 
 | Name                         | Required | Description                                                                                                      | Default value | Example values                           |
-|----------------------------|----------|----------------------------------------|---------------|------------------------------------------------------|
+| ---------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------- |
 | **hydra-url**                | yes      | ORY Hydra's service address                                                                                      | -             | ` ory-hydra-admin.ory.svc.cluster.local` |
 | **hydra-port**               | no       | ORY Hydra's service port                                                                                         | `4445`        | `4445`                                   |
 | **tls-trust-store**          | no       | TLS cert path for hydra client                                                                                   | `""`          | `/etc/ssl/certs/ca-certificates.crt`     |
@@ -64,7 +79,10 @@ To deploy the controller, edit the value of the ```--hydra-url``` argument in th
 
 ### Testing
 
-Use mockery to generate mock types that implement existing interfaces. To generate a mock type for an interface, navigate to the directory containing that interface and run this command:
+Use mockery to generate mock types that implement existing interfaces. To
+generate a mock type for an interface, navigate to the directory containing that
+interface and run this command:
+
 ```
 mockery -name={INTERFACE_NAME}
 ```

api/v1alpha1/zz_generated.deepcopy.go

@@ -1,3 +1,4 @@
+//go:build !ignore_autogenerated
 // +build !ignore_autogenerated
 
 /*

config/crd/bases/hydra.ory.sh_oauth2clients.yaml

@@ -1,4 +1,3 @@
-
 ---
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
@@ -22,33 +21,52 @@ spec:
           description: OAuth2Client is the Schema for the oauth2clients API
           properties:
             apiVersion:
-            description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+              description:
+                "APIVersion defines the versioned schema of this representation
+                of an object. Servers should convert recognized schemas to the
+                latest internal value, and may reject unrecognized values. More
+                info:
+                https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources"
               type: string
             kind:
-            description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+              description:
+                "Kind is a string value representing the REST resource this
+                object represents. Servers may infer this from the endpoint the
+                client submits requests to. Cannot be updated. In CamelCase.
+                More info:
+                https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"
               type: string
             metadata:
               type: object
             spec:
-            description: OAuth2ClientSpec defines the desired state of OAuth2Client
+              description:
+                OAuth2ClientSpec defines the desired state of OAuth2Client
               properties:
                 allowedCorsOrigins:
-                description: AllowedCorsOrigins is an array of allowed CORS origins
+                  description:
+                    AllowedCorsOrigins is an array of allowed CORS origins
                   items:
-                  description: RedirectURI represents a redirect URI for the client
+                    description:
+                      RedirectURI represents a redirect URI for the client
                     pattern: \w+:/?/?[^\s]+
                     type: string
                   type: array
                 audience:
-                description: Audience is a whitelist defining the audiences this client is allowed to request tokens for
+                  description:
+                    Audience is a whitelist defining the audiences this client
+                    is allowed to request tokens for
                   items:
                     type: string
                   type: array
                 clientName:
-                description: ClientName is the human-readable string name of the client to be presented to the end-user during authorization.
+                  description:
+                    ClientName is the human-readable string name of the client
+                    to be presented to the end-user during authorization.
                   type: string
                 grantTypes:
-                description: GrantTypes is an array of grant types the client is allowed to use.
+                  description:
+                    GrantTypes is an array of grant types the client is allowed
+                    to use.
                   items:
                     description: GrantType represents an OAuth 2.0 grant type
                     enum:
@@ -61,22 +79,37 @@ spec:
                   minItems: 1
                   type: array
                 hydraAdmin:
-                description: HydraAdmin is the optional configuration to use for managing this client
+                  description:
+                    HydraAdmin is the optional configuration to use for managing
+                    this client
                   properties:
                     endpoint:
-                    description: Endpoint is the endpoint for the hydra instance on which to set up the client. This value will override the value provided to `--endpoint` (defaults to `"/clients"` in the application)
+                      description:
+                        Endpoint is the endpoint for the hydra instance on which
+                        to set up the client. This value will override the value
+                        provided to `--endpoint` (defaults to `"/clients"` in
+                        the application)
                       pattern: (^$|^/.*)
                       type: string
                     forwardedProto:
-                    description: ForwardedProto overrides the `--forwarded-proto` flag. The value "off" will force this to be off even if `--forwarded-proto` is specified
+                      description:
+                        ForwardedProto overrides the `--forwarded-proto` flag.
+                        The value "off" will force this to be off even if
+                        `--forwarded-proto` is specified
                       pattern: (^$|https?|off)
                       type: string
                     port:
-                    description: Port is the port for the hydra instance on which to set up the client. This value will override the value provided to `--hydra-port`
+                      description:
+                        Port is the port for the hydra instance on which to set
+                        up the client. This value will override the value
+                        provided to `--hydra-port`
                       maximum: 65535
                       type: integer
                     url:
-                    description: URL is the URL for the hydra instance on which to set up the client. This value will override the value provided to `--hydra-url`
+                      description:
+                        URL is the URL for the hydra instance on which to set up
+                        the client. This value will override the value provided
+                        to `--hydra-url`
                       maxLength: 64
                       pattern: (^$|^https?://.*)
                       type: string
@@ -87,23 +120,33 @@ spec:
                   type: object
                   x-kubernetes-preserve-unknown-fields: true
                 postLogoutRedirectUris:
-                description: PostLogoutRedirectURIs is an array of the post logout redirect URIs allowed for the application
+                  description:
+                    PostLogoutRedirectURIs is an array of the post logout
+                    redirect URIs allowed for the application
                   items:
-                  description: RedirectURI represents a redirect URI for the client
+                    description:
+                      RedirectURI represents a redirect URI for the client
                     pattern: \w+:/?/?[^\s]+
                     type: string
                   type: array
                 redirectUris:
-                description: RedirectURIs is an array of the redirect URIs allowed for the application
+                  description:
+                    RedirectURIs is an array of the redirect URIs allowed for
+                    the application
                   items:
-                  description: RedirectURI represents a redirect URI for the client
+                    description:
+                      RedirectURI represents a redirect URI for the client
                     pattern: \w+:/?/?[^\s]+
                     type: string
                   type: array
                 responseTypes:
-                description: ResponseTypes is an array of the OAuth 2.0 response type strings that the client can use at the authorization endpoint.
+                  description:
+                    ResponseTypes is an array of the OAuth 2.0 response type
+                    strings that the client can use at the authorization
+                    endpoint.
                   items:
-                  description: ResponseType represents an OAuth 2.0 response type strings
+                    description:
+                      ResponseType represents an OAuth 2.0 response type strings
                     enum:
                       - id_token
                       - code
@@ -117,11 +160,16 @@ spec:
                   minItems: 1
                   type: array
                 scope:
-                description: Scope is a string containing a space-separated list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749]) that the client can use when requesting access tokens.
+                  description:
+                    Scope is a string containing a space-separated list of scope
+                    values (as described in Section 3.3 of OAuth 2.0 [RFC6749])
+                    that the client can use when requesting access tokens.
                   pattern: ([a-zA-Z0-9\.\*]+\s?)+
                   type: string
                 secretName:
-                description: SecretName points to the K8s secret that contains this client's ID and password
+                  description:
+                    SecretName points to the K8s secret that contains this
+                    client's ID and password
                   maxLength: 253
                   minLength: 1
                   pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*'
@@ -138,7 +186,9 @@ spec:
                         - client_secret_post
                         - private_key_jwt
                         - none
-                description: Indication which authentication method shoud be used for the token endpoint
+                  description:
+                    Indication which authentication method shoud be used for the
+                    token endpoint
                   type: string
               required:
                 - grantTypes
@@ -146,20 +196,28 @@ spec:
                 - secretName
               type: object
             status:
-            description: OAuth2ClientStatus defines the observed state of OAuth2Client
+              description:
+                OAuth2ClientStatus defines the observed state of OAuth2Client
               properties:
                 observedGeneration:
-                description: ObservedGeneration represents the most recent generation observed by the daemon set controller.
+                  description:
+                    ObservedGeneration represents the most recent generation
+                    observed by the daemon set controller.
                   format: int64
                   type: integer
                 reconciliationError:
-                description: ReconciliationError represents an error that occurred during the reconciliation process
+                  description:
+                    ReconciliationError represents an error that occurred during
+                    the reconciliation process
                   properties:
                     description:
-                    description: Description is the description of the reconciliation error
+                      description:
+                        Description is the description of the reconciliation
+                        error
                       type: string
                     statusCode:
-                    description: Code is the status code of the reconciliation error
+                      description:
+                        Code is the status code of the reconciliation error
                       type: string
                   type: object
               type: object

config/default/manager_prometheus_metrics_patch.yaml

@@ -8,7 +8,7 @@ spec:
   template:
     metadata:
       annotations:
-        prometheus.io/scrape: 'true'
+        prometheus.io/scrape: "true"
     spec:
       containers:
         # Expose the prometheus metrics on default port

config/rbac/role.yaml

@@ -1,4 +1,3 @@
-
 ---
 apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRole

config/samples/hydra_v1alpha1_oauth2client.yaml

@@ -36,4 +36,3 @@ spec:
     endpoint: /clients
     forwardedProto: https
   tokenEndpointAuthMethod: client_secret_basic
-  

config/webhook/service.yaml

@@ -1,4 +1,3 @@
-
 apiVersion: v1
 kind: Service
 metadata:

docs/README.md

@@ -1,24 +1,32 @@
 # Design
 
-
 ## Controller design
 
-The controller listens for Custom Resource which defines client registration request. Once Custom resource is created, the controller register oauth2 client in hydra using hydra's REST API.
+The controller listens for Custom Resource which defines client registration
-Client Id, Client Secret and Identifier of the client in hydra are be stored in the kubernetes as a secret and referenced in the applied CR.
+request. Once Custom resource is created, the controller register oauth2 client
-Reference is used to identify in which kubernetes secret are stored mentioned properties. Secret iscreated in the same namespace of applied CR.
+in hydra using hydra's REST API. Client Id, Client Secret and Identifier of the
-By default controller should be deployed in the same pod as hydra. Service discovery will come in place in the future.
+client in hydra are be stored in the kubernetes as a secret and referenced in
+the applied CR. Reference is used to identify in which kubernetes secret are
+stored mentioned properties. Secret iscreated in the same namespace of applied
+CR. By default controller should be deployed in the same pod as hydra. Service
+discovery will come in place in the future.
 
-Custom Resource should be Namespace scoped to enable isolation in k8s.
+Custom Resource should be Namespace scoped to enable isolation in k8s. It is
-It is represented in the diagram 
+represented in the diagram
 
 ![diagram](./assets/workflow.svg)
 
 ## Synchronization mode
 
-Additionally, controller supports synchronization mode, where it tries to register all clients in hydra.
+Additionally, controller supports synchronization mode, where it tries to
-Synchronization is an optional mode, enabled via config, which is meant for use cases where hydra is deployed with in memory storage.
+register all clients in hydra. Synchronization is an optional mode, enabled via
-If hydra pod is restarted for some reason then it does not have client in its storage. With synchronization mode the controller makes sure that hydra has up to date clients.
+config, which is meant for use cases where hydra is deployed with in memory
-Synchronization is done by making POST request to hydra with payload describing all client information including clientID,clientSecret and Identifier of last applied client.
+storage. If hydra pod is restarted for some reason then it does not have client
-If client exists in hydra storage 409 is returned which is considered as ok and synchronization continues with other clients.
+in its storage. With synchronization mode the controller makes sure that hydra
+has up to date clients. Synchronization is done by making POST request to hydra
+with payload describing all client information including clientID,clientSecret
+and Identifier of last applied client. If client exists in hydra storage 409 is
+returned which is considered as ok and synchronization continues with other
+clients.
 
 ![diagram](./assets/synchronization-mode.svg)

package-lock.json

@@ -0,0 +1,48 @@
+{
+  "name": "hydra-maester",
+  "lockfileVersion": 2,
+  "requires": true,
+  "packages": {
+    "": {
+      "devDependencies": {
+        "ory-prettier-styles": "1.3.0",
+        "prettier": "2.7.1"
+      }
+    },
+    "node_modules/ory-prettier-styles": {
+      "version": "1.3.0",
+      "resolved": "https://registry.npmjs.org/ory-prettier-styles/-/ory-prettier-styles-1.3.0.tgz",
+      "integrity": "sha512-Vfn0G6CyLaadwcCamwe1SQCf37ZQfBDgMrhRI70dE/2fbE3Q43/xu7K5c32I5FGt/EliroWty5yBjmdkj0eWug==",
+      "dev": true
+    },
+    "node_modules/prettier": {
+      "version": "2.7.1",
+      "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.7.1.tgz",
+      "integrity": "sha512-ujppO+MkdPqoVINuDFDRLClm7D78qbDt0/NR+wp5FqEZOoTNAjPHWj17QRhu7geIHJfcNhRk1XVQmF8Bp3ye+g==",
+      "dev": true,
+      "bin": {
+        "prettier": "bin-prettier.js"
+      },
+      "engines": {
+        "node": ">=10.13.0"
+      },
+      "funding": {
+        "url": "https://github.com/prettier/prettier?sponsor=1"
+      }
+    }
+  },
+  "dependencies": {
+    "ory-prettier-styles": {
+      "version": "1.3.0",
+      "resolved": "https://registry.npmjs.org/ory-prettier-styles/-/ory-prettier-styles-1.3.0.tgz",
+      "integrity": "sha512-Vfn0G6CyLaadwcCamwe1SQCf37ZQfBDgMrhRI70dE/2fbE3Q43/xu7K5c32I5FGt/EliroWty5yBjmdkj0eWug==",
+      "dev": true
+    },
+    "prettier": {
+      "version": "2.7.1",
+      "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.7.1.tgz",
+      "integrity": "sha512-ujppO+MkdPqoVINuDFDRLClm7D78qbDt0/NR+wp5FqEZOoTNAjPHWj17QRhu7geIHJfcNhRk1XVQmF8Bp3ye+g==",
+      "dev": true
+    }
+  }
+}

package.json

@@ -0,0 +1,8 @@
+{
+  "private": true,
+  "prettier": "ory-prettier-styles",
+  "devDependencies": {
+    "ory-prettier-styles": "1.3.0",
+    "prettier": "2.7.1"
+  }
+}