Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve project matching logic #575

Merged
merged 2 commits into from
Nov 23, 2023
Merged

Improve project matching logic #575

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cd5a9c9
fix(synchronizer): improve project matching logic
f1ames Nov 23, 2023
25b86ff
chore: add changeset
f1ames Nov 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/quick-hornets-call.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@monokle/synchronizer": patch
---

Improved project matching logic.
0 ...thubcom-kubeshop-monokle-core.policy.yaml → .../github-kubeshop-monokle-core.policy.yaml
View file
Open in desktop
File renamed without changes.
222 changes: 210 additions & 12 deletions packages/synchronizer/src/__tests__/synchronizer.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ describe('Synchronizer Tests', () => {
const synchronizer = createDefaultMonokleSynchronizer(new StorageHandlerPolicy(storagePath));

const policy = await synchronizer.getPolicy({
provider: 'github.com',
provider: 'GITHUB',
remote: 'origin',
owner: 'kubeshop',
name: 'monokle-core',
Expand All @@ -55,24 +55,24 @@ describe('Synchronizer Tests', () => {
});

it('returns policy if there is policy file (from path)', async () => {
const storagePath = await createTmpConfigDir('githubcom-kubeshop-monokle-core.policy.yaml');
const storagePath = await createTmpConfigDir('github-kubeshop-monokle-core.policy.yaml');
const synchronizer = createDefaultMonokleSynchronizer(new StorageHandlerPolicy(storagePath));

const policy = await synchronizer.getPolicy(storagePath);

assert.isObject(policy);
assert.isTrue(policy.valid);
assert.isNotEmpty(policy.path);
assert.match(policy.path, /githubcom-kubeshop-monokle-core.policy.yaml$/);
assert.match(policy.path, /github-kubeshop-monokle-core.policy.yaml$/);
assert.isNotEmpty(policy.policy);
});

it('returns policy if there is policy file (from git data)', async () => {
const storagePath = await createTmpConfigDir('githubcom-kubeshop-monokle-core.policy.yaml');
const storagePath = await createTmpConfigDir('github-kubeshop-monokle-core.policy.yaml');
const synchronizer = createDefaultMonokleSynchronizer(new StorageHandlerPolicy(storagePath));

const policy = await synchronizer.getPolicy({
provider: 'github.com',
provider: 'GITHUB',
remote: 'origin',
owner: 'kubeshop',
name: 'monokle-core',
Expand All @@ -81,7 +81,7 @@ describe('Synchronizer Tests', () => {
assert.isObject(policy);
assert.isTrue(policy.valid);
assert.isNotEmpty(policy.path);
assert.match(policy.path, /githubcom-kubeshop-monokle-core.policy.yaml$/);
assert.match(policy.path, /github-kubeshop-monokle-core.policy.yaml$/);
assert.isNotEmpty(policy.policy);
assert.isNotEmpty(policy.policy.plugins);
});
Expand Down Expand Up @@ -172,7 +172,7 @@ describe('Synchronizer Tests', () => {
stubs.push(queryApiStub);

const repoData = {
provider: 'github.com',
provider: 'GITHUB',
remote: 'origin',
owner: 'kubeshop',
name: 'monokle-core',
Expand All @@ -190,7 +190,7 @@ describe('Synchronizer Tests', () => {
assert.isObject(newPolicy);
assert.isTrue(newPolicy.valid);
assert.isNotEmpty(newPolicy.path);
assert.match(newPolicy.path, /githubcom-kubeshop-monokle-core.policy.yaml$/);
assert.match(newPolicy.path, /github-kubeshop-monokle-core.policy.yaml$/);
assert.isNotEmpty(newPolicy.policy);
assert.isNotEmpty(newPolicy.policy.plugins);
assert.isNotEmpty(newPolicy.policy.rules);
Expand Down Expand Up @@ -270,6 +270,204 @@ describe('Synchronizer Tests', () => {
assert.deepEqual(newPolicy, getPolicyResult);
});

it('fetches and returns valid policy based on repo data (GITHUB provider)', async () => {
const storagePath = await createTmpConfigDir();
const synchronizer = createDefaultMonokleSynchronizer(new StorageHandlerPolicy(storagePath));

const queryApiStub = sinon.stub((synchronizer as any)._apiHandler, 'queryApi').callsFake(async (...args) => {
const query = args[0] as string;

if (query.includes('query getUser')) {
return {
data: {
me: {
id: 7,
email: '[email protected]',
projects: [
{
project: {
id: 7000,
slug: 'user7-proj',
name: 'User7 Project',
repositories: [
{
id: 'user7-proj-policy-id',
projectId: 7000,
provider: 'GITHUB',
owner: 'kubeshop',
name: 'monokle-core',
prChecks: false,
canEnablePrChecks: true,
},
],
},
},
],
},
},
};
}

if (query.includes('query getPolicy')) {
return {
data: {
getProject: {
id: 7000,
name: 'User7 Project',
policy: {
id: 'user7-proj-policy-id',
json: {
plugins: {
'pod-security-standards': true,
'yaml-syntax': false,
'resource-links': false,
'kubernetes-schema': false,
practices: true,
},
rules: {
'pod-security-standards/host-process': 'err',
},
settings: {
'kubernetes-schema': {
schemaVersion: 'v1.27.1',
},
},
},
},
},
},
};
}

return {};
});
stubs.push(queryApiStub);

const repoData = {
provider: 'GITHUB',
remote: 'origin',
owner: 'kubeshop',
name: 'monokle-core',
};

const policy = await synchronizer.getPolicy(repoData);

assert.isFalse(policy.valid);

const newPolicy = await synchronizer.getPolicy(repoData, true, {
accessToken: 'SAMPLE_ACCESS_TOKEN',
tokenType: 'ApiKey',
});

assert.isObject(newPolicy);
assert.isTrue(newPolicy.valid);
assert.isNotEmpty(newPolicy.path);
assert.match(newPolicy.path, /github-kubeshop-monokle-core.policy.yaml$/);
assert.isNotEmpty(newPolicy.policy);
assert.isNotEmpty(newPolicy.policy.plugins);
assert.isNotEmpty(newPolicy.policy.rules);
assert.isNotEmpty(newPolicy.policy.settings);
});

it('fetches and returns valid policy based on repo data (HTTPS provider)', async () => {
const storagePath = await createTmpConfigDir();
const synchronizer = createDefaultMonokleSynchronizer(new StorageHandlerPolicy(storagePath));

const queryApiStub = sinon.stub((synchronizer as any)._apiHandler, 'queryApi').callsFake(async (...args) => {
const query = args[0] as string;

if (query.includes('query getUser')) {
return {
data: {
me: {
id: 8,
email: '[email protected]',
projects: [
{
project: {
id: 8000,
slug: 'user8-proj',
name: 'User8 Project',
repositories: [
{
id: 'user8-proj-policy-id',
projectId: 8000,
provider: 'HTTPS',
owner: 'sample-org',
name: 'demo',
prChecks: false,
canEnablePrChecks: true,
},
],
},
},
],
},
},
};
}

if (query.includes('query getPolicy')) {
return {
data: {
getProject: {
id: 8000,
name: 'User8 Project',
policy: {
id: 'user8-proj-policy-id',
json: {
plugins: {
'pod-security-standards': true,
'yaml-syntax': false,
'resource-links': false,
'kubernetes-schema': false,
practices: true,
},
rules: {
'pod-security-standards/host-process': 'err',
},
settings: {
'kubernetes-schema': {
schemaVersion: 'v1.27.1',
},
},
},
},
},
},
};
}

return {};
});
stubs.push(queryApiStub);

const repoData = {
provider: 'HTTPS',
remote: 'origin',
owner: 'sample-org',
name: 'demo',
};

const policy = await synchronizer.getPolicy(repoData);

assert.isFalse(policy.valid);

const newPolicy = await synchronizer.getPolicy(repoData, true, {
accessToken: 'SAMPLE_ACCESS_TOKEN',
tokenType: 'ApiKey',
});

assert.isObject(newPolicy);
assert.isTrue(newPolicy.valid);
assert.isNotEmpty(newPolicy.path);
assert.match(newPolicy.path, /https-sample-org-demo.policy.yaml$/);
assert.isNotEmpty(newPolicy.policy);
assert.isNotEmpty(newPolicy.policy.plugins);
assert.isNotEmpty(newPolicy.policy.rules);
assert.isNotEmpty(newPolicy.policy.settings);
});

it('throws unauthorized error when invalid auth credentials passed', async () => {
const storagePath = await createTmpConfigDir();
const synchronizer = createDefaultMonokleSynchronizer(new StorageHandlerPolicy(storagePath));
Expand Down Expand Up @@ -433,7 +631,7 @@ describe('Synchronizer Tests', () => {
stubs.push(queryApiStub);

const repoData = {
provider: 'github.com',
provider: 'GITHUB',
remote: 'origin',
owner: 'kubeshop',
name: 'monokle-core',
Expand All @@ -445,7 +643,7 @@ describe('Synchronizer Tests', () => {
assert.isObject(policy);
assert.isTrue(policy.valid);
assert.isNotEmpty(policy.path);
assert.match(policy.path, /githubcom-kubeshop-monokle-core.policy.yaml$/);
assert.match(policy.path, /github-kubeshop-monokle-core.policy.yaml$/);
assert.isNotEmpty(policy.policy);
assert.isNotEmpty(policy.policy.plugins);
assert.isNotEmpty(policy.policy.rules);
Expand Down Expand Up @@ -507,7 +705,7 @@ describe('Synchronizer Tests', () => {
stubs.push(queryApiStub);

const repoData = {
provider: 'github.com',
provider: 'GITHUB',
remote: 'origin',
owner: 'kubeshop',
name: 'monokle-core',
Expand Down Expand Up @@ -608,7 +806,7 @@ describe('Synchronizer Tests', () => {
stubs.push(queryApiStub);

const repoData = {
provider: 'github.com',
provider: 'GITHUB',
remote: 'origin',
owner: 'kubeshop',
name: 'monokle-core',
Expand Down
47 changes: 46 additions & 1 deletion packages/synchronizer/src/handlers/gitHandler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,15 @@ export type RepoRemoteData = {
remote: string;
owner: string;
name: string;
details?: gitUrlParse.GitUrl;
};

export const KNOWN_GIT_PROVIDERS: Record<string, string> = {
'github.com': 'GITHUB',
};

export const GENERIC_GIT_PROVIDER = 'HTTPS';

export class GitHandler {
async getRepoRemoteData(folderPath: string): Promise<RepoRemoteData | undefined> {
if (!(await this.isGitRepo(folderPath))) {
Expand All @@ -25,10 +32,11 @@ export class GitHandler {
const urlParts = gitUrlParse(url);

return {
provider: urlParts.source,
provider: this.matchProvider(urlParts),
remote: remote.name,
owner: urlParts.owner,
name: urlParts.name,
details: urlParts,
};
} catch (err: any) {
return undefined;
Expand Down Expand Up @@ -61,4 +69,41 @@ export class GitHandler {
}
}
}

// Sample `gitUrlParse.GitUrl` object (as it's not fully consistent with TS typings):
// {
// protocols: [ 'ssh' ],
// protocol: 'ssh',
// port: '',
// resource: 'github.com',
// host: 'github.com',
// user: 'git',
// password: '',
// pathname: '/kubeshop/monokle-demo.git',
// hash: '',
// search: '',
// href: '[email protected]:kubeshop/monokle-demo.git',
// query: {},
// parse_failed: false,
// token: '',
// toString: [Function (anonymous)],
// source: 'github.com',
// git_suffix: true,
// name: 'monokle-demo',
// owner: 'kubeshop',
// commit: undefined,
// ref: '',
// filepathtype: '',
// filepath: '',
// organization: 'kubeshop',
// full_name: 'kubeshop/monokle-demo'
// }
private matchProvider(repoMetadata: gitUrlParse.GitUrl) {
return (
KNOWN_GIT_PROVIDERS[repoMetadata.source] ||
KNOWN_GIT_PROVIDERS[repoMetadata.resource] ||
KNOWN_GIT_PROVIDERS[(repoMetadata as any).host] ||
GENERIC_GIT_PROVIDER
);
}
}
Loading
Loading