Gitops GitHub create wizard #36

Abiji-2020 · 2024-11-23T11:54:48Z

Created the complete GitOps flow for GitHub

Created component based design
Added unit tests

closes #19
@quest-bot loot #19

Test Coverage

Demo video

Permit-gitops.flow.test.mp4

Signed-off-by: Abinand P <[email protected]>

Abiji-2020 · 2024-11-23T11:56:07Z

@quest-bot loot #19

quest-bot · 2024-11-23T11:56:12Z

Quest PR submitted!

@Abiji-2020, you are attempting to solve the issue and loot this Quest. Will you be successful?

Questions? Check out the docs.

Abiji-2020 · 2024-11-23T11:56:49Z

@gemanor @orweis can you review this PR?

gemanor · 2024-11-24T12:07:32Z

@Abiji-2020, it looks good at first sight; thanks for your contribution.

To continue with a more detailed review, I will ask you to proceed with the following:

Merge with the main repo (opened PR) so we can ensure lint
Take the API key either from the keychain and add an option to provide it as an argument named --key. You can see an example in the check commands

Please let me know when you're done, and I'll proceed with more detailed review.

Update Lint Command

…l use the default account stored. Signed-off-by: Abinand P <[email protected]>

…i-2020/permit-cli into gitops-github-create-wizard

orweis · 2024-11-24T13:17:57Z

The copy SSH key stage is very clunky -

You need to edit out the newlines
It's unclear which part to copy paste (Even just visually)
- maybe it would be better to set the clipboard directly from the app (maybe with something like- https://github.com/sindresorhus/clipboardy)

Abiji-2020 · 2024-11-24T13:24:58Z

@Abiji-2020, it looks good at first sight; thanks for your contribution.

To continue with a more detailed review, I will ask you to proceed with the following:

Merge with the main repo (opened PR) so we can ensure lint

Take the API key either from the keychain and add an option to provide it as an argument named --key. You can see an example in the check commands

Please let me know when you're done, and I'll proceed with more detailed review.

@gemanor I have modified, to use the API Key either from the command line as option. and if it is not given, we will take it the default API value stored in keychain.

example

Abiji-2020 · 2024-11-24T13:26:27Z

The copy SSH key stage is very clunky -

You need to edit out the newlines

It's unclear which part to copy paste (Even just visually)

maybe it would be better to set the clipboard directly from the app (maybe with something like- https://github.com/sindresorhus/clipboardy)

I have edited out the newlines and copying to clipboard is necessary? If wanted let me add it too

…ew line Signed-off-by: Abinand P <[email protected]>

gemanor · 2024-11-24T14:27:41Z

@Abiji-2020, it looks good at first sight; thanks for your contribution.
To continue with a more detailed review, I will ask you to proceed with the following:

Merge with the main repo (opened PR) so we can ensure lint

Take the API key either from the keychain and add an option to provide it as an argument named --key. You can see an example in the check commands

Please let me know when you're done, and I'll proceed with more detailed review.

@gemanor I have modified, to use the API Key either from the command line as option. and if it is not given, we will take it the default API value stored in keychain.

example

It should use the --key arguments only if they are present and use the keychain as the default, not as a default argument to the command. Please look at the check commands and use the same convention as they are there.

gemanor · 2024-11-24T14:45:05Z

Also, @Abiji-2020, I'm trying to run the tests locally, but couldn't. Please merge from Main, fix all the lint errors, and ensure the test is passing.

gemanor · 2024-11-24T14:49:36Z

Another issue is the follwoing error that I get when running it:

node:internal/modules/cjs/loader:1225
  const err = new Error(message);
              ^

Error: Cannot find module '../build/Release/keytar.node'
Require stack:
- /Users/gemanor/dev/cli-gitops/node_modules/keytar/lib/keytar.js
    at Module._resolveFilename (node:internal/modules/cjs/loader:1225:15)
    at Module._load (node:internal/modules/cjs/loader:1051:27)
    at Module.require (node:internal/modules/cjs/loader:1311:19)
    at require (node:internal/modules/helpers:179:18)
    at Object.<anonymous> (/Users/gemanor/dev/cli-gitops/node_modules/keytar/lib/keytar.js:1:14)
    at Module._compile (node:internal/modules/cjs/loader:1469:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1548:10)
    at Module.load (node:internal/modules/cjs/loader:1288:32)
    at Module._load (node:internal/modules/cjs/loader:1104:12)
    at cjsLoader (node:internal/modules/esm/translators:346:17) {
  code: 'MODULE_NOT_FOUND',
  requireStack: [ '/Users/gemanor/dev/cli-gitops/node_modules/keytar/lib/keytar.js' ]
}

Abiji-2020 · 2024-11-24T15:03:47Z

Another issue is the follwoing error that I get when running it:

node:internal/modules/cjs/loader:1225
  const err = new Error(message);
              ^

Error: Cannot find module '../build/Release/keytar.node'
Require stack:
- /Users/gemanor/dev/cli-gitops/node_modules/keytar/lib/keytar.js
    at Module._resolveFilename (node:internal/modules/cjs/loader:1225:15)
    at Module._load (node:internal/modules/cjs/loader:1051:27)
    at Module.require (node:internal/modules/cjs/loader:1311:19)
    at require (node:internal/modules/helpers:179:18)
    at Object.<anonymous> (/Users/gemanor/dev/cli-gitops/node_modules/keytar/lib/keytar.js:1:14)
    at Module._compile (node:internal/modules/cjs/loader:1469:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1548:10)
    at Module.load (node:internal/modules/cjs/loader:1288:32)
    at Module._load (node:internal/modules/cjs/loader:1104:12)
    at cjsLoader (node:internal/modules/esm/translators:346:17) {
  code: 'MODULE_NOT_FOUND',
  requireStack: [ '/Users/gemanor/dev/cli-gitops/node_modules/keytar/lib/keytar.js' ]
}

This issue is that keytar is missing right?

UPDATE: I cannot reproduce this issue, could give me the steps to reproduce?

Signed-off-by: Abinand P <[email protected]>

Abiji-2020 · 2024-11-24T15:15:43Z

@gemanor apologies, as I haven't added the test to the scripts which are added now, and in the linting it shows warnings of the empty dependencies in useEffect, as I wanted to call them only once, I have used an empty array (to call them when only mounted). and the option --key was added as per the conditions.

If we use the argument --key then it will go with the apiKey in --key argument else it will go with the default key in keychain.

There are some existing errors in https://github.com/permitio/permit-cli/blob/main/test.tsx

gemanor · 2024-11-24T17:17:00Z

Another issue is the follwoing error that I get when running it:

node:internal/modules/cjs/loader:1225
  const err = new Error(message);
              ^

Error: Cannot find module '../build/Release/keytar.node'
Require stack:
- /Users/gemanor/dev/cli-gitops/node_modules/keytar/lib/keytar.js
    at Module._resolveFilename (node:internal/modules/cjs/loader:1225:15)
    at Module._load (node:internal/modules/cjs/loader:1051:27)
    at Module.require (node:internal/modules/cjs/loader:1311:19)
    at require (node:internal/modules/helpers:179:18)
    at Object.<anonymous> (/Users/gemanor/dev/cli-gitops/node_modules/keytar/lib/keytar.js:1:14)
    at Module._compile (node:internal/modules/cjs/loader:1469:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1548:10)
    at Module.load (node:internal/modules/cjs/loader:1288:32)
    at Module._load (node:internal/modules/cjs/loader:1104:12)
    at cjsLoader (node:internal/modules/esm/translators:346:17) {
  code: 'MODULE_NOT_FOUND',
  requireStack: [ '/Users/gemanor/dev/cli-gitops/node_modules/keytar/lib/keytar.js' ]
}

This issue is that keytar is missing right?

UPDATE: I cannot reproduce this issue, could give me the steps to reproduce?

What version of Node.js are you using?

gemanor · 2024-11-24T17:27:38Z

Works for me now. Will do CR soon.

Can you tell me what do you mean by policy_name? where is that being used?

Signed-off-by: Abinand P <[email protected]>

Abiji-2020 · 2024-11-25T12:59:51Z

@gemanor Apart from the AuthProvider Everything is modified. I am waiting to know more about how to implement the AuthProvider.

permit-cli/source/commands/pdp/run.tsx

Lines 17 to 22 in f70b563

    
           export default function Run({ options: { opa } }: Props) { 
        
           	return ( 
        
           		<AuthProvider> 
        
           			<PDPCommand opa={opa} /> 
        
           		</AuthProvider> 
        
           	);

In this we are making AuthProvider as the parent node and the components as the child node, so should we encapsulate all the components within the AuthProvider or we can do it as in the place before the project state.

permit-cli/source/commands/gitops/create/github.tsx

Lines 92 to 94 in 52d466b

    
           {state === 'project' && ( 
        
           	<SelectProject

{	state === 'apiKey' && (<AuthProvider>
	{	const {authToken} = useAuth();
		setApiKey(authToken);
		setState('project');
	}
	</AuthProvider>)
}

Signed-off-by: Abinand P <[email protected]>

gemanor · 2024-11-25T18:35:58Z

We don't have now "parent" component, so you need to wrap the GitHub create command, and encapsulate its functionality that needs the API key to components.

Abiji-2020 · 2024-11-26T00:28:16Z

We don't have now "parent" component, so you need to wrap the GitHub create command, and encapsulate its functionality that needs the API key to components.

I am unable to grasp the things, could you elaborate more @gemanor , and instead of auth provider can't we use

permit-cli/source/lib/auth.ts

Lines 50 to 65 in f70b563

    
           }; 
        
           export const loadAuthToken = async (): Promise<string> => { 
        
           	const token = await getPassword( 
        
           		KEYSTORE_PERMIT_SERVICE_NAME, 
        
           		DEFAULT_PERMIT_KEYSTORE_ACCOUNT, 
        
           	); 
        
           	if (!token) { 
        
           		throw new Error( 
        
           			'No token found, use `permit login` command to get an auth token', 
        
           		); 
        
           	} 
        
           	return token; 
        
           };

which simplifies and also gets the APIkey from Keychain.

Since AuthProvider also provides the same way

permit-cli/source/components/AuthProvider.tsx

Lines 26 to 34 in f70b563

    
           const fetchAuthToken = async () => { 
        
           	try { 
        
           		const token = await loadAuthToken(); 
        
           		setAuthToken(token); 
        
           	} catch (error) { 
        
           		setError(error instanceof Error ? error.message : String(error)); 
        
           	} 
        
           	setLoading(false);

…Token() Signed-off-by: Abinand P <[email protected]>

gemanor · 2024-11-26T08:47:13Z

The intent to use the AuthProvider, is to make its logic shared across components, so we can later extend its functionality with other stuff. The load is a util function, not logical function.
This is why it is important to use the AuthProvider.

Abiji-2020 · 2024-11-26T08:58:42Z

So shall I create a new file with the complete github component and have an encapultate in the command similar to how we have exactly in https://github.com/permitio/permit-cli/blob/main/source/commands/pdp/run.tsx ? @gemanor

…o created a new component Signed-off-by: Abinand P <[email protected]>

Abiji-2020 · 2024-11-26T15:00:29Z

@gemanor I have added the AuthProvider by creating a new component similar to how it is done in https://github.com/permitio/permit-cli/blob/main/source/commands/pdp/run.tsx and also there are no linting errors.

gemanor

I tested the flow and it's not working. Please fix that (or report errors if there are any).

Also, left some other comments. Please address them.

source/commands/gitops/create/github.tsx

source/lib/gitops/utils.ts

package.json

source/components/gitops/RepositoryKey.tsx

source/components/gitops/SSHKey.tsx

source/lib/gitops/utils.ts

source/components/gitops/SSHKey.tsx

…nd also modified the changes requested Signed-off-by: Abinand P <[email protected]>

Signed-off-by: Abinand P <[email protected]>

Abiji-2020 · 2024-11-27T13:05:32Z

I tested the flow and it's not working. Please fix that (or report errors if there are any).

Also, left some other comments. Please address them.

yeah it is broken in the BranchName component, it is fixed.

….json Signed-off-by: Abinand P <[email protected]>

gemanor · 2024-11-29T07:15:17Z

Now I get an error when trying to save:

GitOps Configuration Wizard - GitHub


 Error: Invalid Configuration [object Object]

Abiji-2020 · 2024-11-29T07:22:36Z

Now I get an error when trying to save:
GitOps Configuration Wizard - GitHub


 Error: Invalid Configuration [object Object]

@gemanor again i tested my workflow it seems just to be working fine. could you give me more info on this?

gemanor · 2024-11-29T07:26:22Z

Okay, the problem is the browser login flow. It works only with key, let me try to fix that.

Another problem, is handling error with activate call. Even when it's succeed, it gets error after saving.
Can you take a look on that please?

Abiji-2020 · 2024-11-29T07:37:13Z

@gemanor I think we need to delay the activate component a little bit as, when i try to activate it immediately it showed me error but for the same when i paused for a minute and then try to activate it, it worked.

gemanor · 2024-11-29T07:51:17Z

The logic should be a little different. The policy repository is on status of pending and you can't activate a pending repository.

It is not about delaying in 1 minute; it is about waiting for the repository status to be valid.

We can solve it with two options, the first is the easiest IMO:

Remove the activate step, and instead give the user an optional --inactive argument on the command. When you're creating the repository (configure step), you'll do the activate_when_validated false only if the --inactive is present. By default, you'll pass it as true.
Call the get repository in 10 seconds interval until it's validated.

Again, IMO, removing the activate step and instead use argument to disable the activate_when_validated attribute when creating, is the best option

package.json

…ted in the payload Signed-off-by: Abinand P <[email protected]>

Abiji-2020 · 2024-11-29T08:17:50Z

The logic should be a little different. The policy repository is on status of pending and you can't activate a pending repository.

It is not about delaying in 1 minute; it is about waiting for the repository status to be valid.

We can solve it with two options, the first is the easiest IMO:

Remove the activate step, and instead give the user an optional --inactive argument on the command. When you're creating the repository (configure step), you'll do the activate_when_validated false only if the --inactive is present. By default, you'll pass it as true.

Call the get repository in 10 seconds interval until it's validated.

Again, IMO, removing the activate step and instead use argument to disable the activate_when_validated attribute when creating, is the best option

@gemanor I have modified the code to go with the option1 flow

gemanor

Nice work!

Abiji-2020 · 2024-12-02T09:07:57Z

@gemanor could you check on the quest loot is not yet released for this ?

quest-bot · 2024-12-09T09:14:09Z

🧚 @Abiji-2020 congratulations for completing Quest #19

💰 A reward of $300 has been credited to you.

To claim your $300 reward follow the instructions here.

Questions? Check out the docs.

Abiji-2020 added 9 commits November 21, 2024 12:29

feat: Added a API component to add the gitops flow in github create

d878848

Signed-off-by: Abinand P <[email protected]>

feat: Added the selectProject component

c071c4f

Signed-off-by: Abinand P <[email protected]>

test: Added tests for selectProject

7b0f153

Signed-off-by: Abinand P <[email protected]>

chore: renamed tests folder

a9ac84d

Signed-off-by: Abinand P <[email protected]>

feat: Added conditions and testing to add a policy name

0eb291b

Signed-off-by: Abinand P <[email protected]>

chore: minor fixing of warnings

1ed75ee

Signed-off-by: Abinand P <[email protected]>

feat: Added the SSH key component

9f8aaef

Signed-off-by: Abinand P <[email protected]>

chore: formatted the code

0c86ae7

Signed-off-by: Abinand P <[email protected]>

feat: completed the gitops flow

27f85ca

Signed-off-by: Abinand P <[email protected]>

quest-bot bot added the ⚔️ Quest Tracks quest-bot quests label Nov 23, 2024

quest-bot bot mentioned this pull request Nov 23, 2024

Permit GitOps Flow Wizard #19

Closed

Abiji-2020 added 3 commits November 24, 2024 17:39

Merge pull request #1 from permitio/main

4438f25

Update Lint Command

feat: Added the API through the argument and if not given then it wil…

b1c1601

…l use the default account stored. Signed-off-by: Abinand P <[email protected]>

Merge branch 'gitops-github-create-wizard' of https://github.com/Abij…

41a8541

…i-2020/permit-cli into gitops-github-create-wizard

fix: fixed the displaying issues in the SSH Key to copy by adding a n…

89f69d2

…ew line Signed-off-by: Abinand P <[email protected]>

fix: fixed some bugs and added test in the script

4d2fa14

Signed-off-by: Abinand P <[email protected]>

chore: modified the components as per the review

52d466b

Signed-off-by: Abinand P <[email protected]>

Abiji-2020 requested a review from gemanor November 25, 2024 12:50

lint: fixed an liniting issue

d02145e

Signed-off-by: Abinand P <[email protected]>

chore: instead of the complete logic modifed the code to use loadAuth…

cf42ea7

…Token() Signed-off-by: Abinand P <[email protected]>

chore: Added AuthProvider in the gitops create github command and als…

b84b780

…o created a new component Signed-off-by: Abinand P <[email protected]>

gemanor requested changes Nov 27, 2024

View reviewed changes

Abiji-2020 added 2 commits November 27, 2024 18:28

chore: fixed some of the code changes and removed the color updates a…

54cfc74

…nd also modified the changes requested Signed-off-by: Abinand P <[email protected]>

chore: renamed the accesToken to apiKey

e9fd656

Signed-off-by: Abinand P <[email protected]>

Abiji-2020 requested a review from gemanor November 27, 2024 13:05

test: fixed some test erros and added the coverage command in package…

4db2917

….json Signed-off-by: Abinand P <[email protected]>

gemanor reviewed Nov 29, 2024

View reviewed changes

package.json Outdated Show resolved Hide resolved

gemanor and others added 2 commits November 29, 2024 09:57

Update package.json

bf5efbb

chore: removed the activate componennt and added activate_when_valida…

0eb1643

…ted in the payload Signed-off-by: Abinand P <[email protected]>

gemanor approved these changes Nov 29, 2024

View reviewed changes

gemanor merged commit 51dea81 into permitio:main Nov 29, 2024
3 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Gitops GitHub create wizard #36

Gitops GitHub create wizard #36

Abiji-2020 commented Nov 23, 2024

Abiji-2020 commented Nov 23, 2024

quest-bot bot commented Nov 23, 2024

Abiji-2020 commented Nov 23, 2024 •

edited

Loading

gemanor commented Nov 24, 2024

orweis commented Nov 24, 2024

Abiji-2020 commented Nov 24, 2024

Abiji-2020 commented Nov 24, 2024

gemanor commented Nov 24, 2024 •

edited

Loading

example

gemanor commented Nov 24, 2024

gemanor commented Nov 24, 2024

Abiji-2020 commented Nov 24, 2024 •

edited

Loading

Abiji-2020 commented Nov 24, 2024 •

edited

Loading

gemanor commented Nov 24, 2024

gemanor commented Nov 24, 2024 •

edited

Loading

Abiji-2020 commented Nov 25, 2024 •

edited

Loading

gemanor commented Nov 25, 2024

Abiji-2020 commented Nov 26, 2024 •

edited

Loading

gemanor commented Nov 26, 2024

Abiji-2020 commented Nov 26, 2024

Abiji-2020 commented Nov 26, 2024

gemanor left a comment •

edited

Loading

Abiji-2020 commented Nov 27, 2024

gemanor commented Nov 29, 2024

Abiji-2020 commented Nov 29, 2024

gemanor commented Nov 29, 2024

Abiji-2020 commented Nov 29, 2024

gemanor commented Nov 29, 2024

Abiji-2020 commented Nov 29, 2024

gemanor left a comment

Abiji-2020 commented Dec 2, 2024

quest-bot bot commented Dec 9, 2024

Gitops GitHub create wizard #36

Gitops GitHub create wizard #36

Conversation

Abiji-2020 commented Nov 23, 2024

Created the complete GitOps flow for GitHub

Test Coverage

Demo video

Abiji-2020 commented Nov 23, 2024

quest-bot bot commented Nov 23, 2024

Quest PR submitted!

Abiji-2020 commented Nov 23, 2024 • edited Loading

gemanor commented Nov 24, 2024

orweis commented Nov 24, 2024

Abiji-2020 commented Nov 24, 2024

example

Abiji-2020 commented Nov 24, 2024

gemanor commented Nov 24, 2024 • edited Loading

example

gemanor commented Nov 24, 2024

gemanor commented Nov 24, 2024

Abiji-2020 commented Nov 24, 2024 • edited Loading

Abiji-2020 commented Nov 24, 2024 • edited Loading

gemanor commented Nov 24, 2024

gemanor commented Nov 24, 2024 • edited Loading

Abiji-2020 commented Nov 25, 2024 • edited Loading

gemanor commented Nov 25, 2024

Abiji-2020 commented Nov 26, 2024 • edited Loading

gemanor commented Nov 26, 2024

Abiji-2020 commented Nov 26, 2024

Abiji-2020 commented Nov 26, 2024

gemanor left a comment • edited Loading

Choose a reason for hiding this comment

Abiji-2020 commented Nov 27, 2024

gemanor commented Nov 29, 2024

Abiji-2020 commented Nov 29, 2024

gemanor commented Nov 29, 2024

Abiji-2020 commented Nov 29, 2024

gemanor commented Nov 29, 2024

Abiji-2020 commented Nov 29, 2024

gemanor left a comment

Choose a reason for hiding this comment

Abiji-2020 commented Dec 2, 2024

quest-bot bot commented Dec 9, 2024

Abiji-2020 commented Nov 23, 2024 •

edited

Loading

gemanor commented Nov 24, 2024 •

edited

Loading

Abiji-2020 commented Nov 24, 2024 •

edited

Loading

Abiji-2020 commented Nov 24, 2024 •

edited

Loading

gemanor commented Nov 24, 2024 •

edited

Loading

Abiji-2020 commented Nov 25, 2024 •

edited

Loading

Abiji-2020 commented Nov 26, 2024 •

edited

Loading

gemanor left a comment •

edited

Loading