Feat: editorial workflow bitbucket gitlab (#3014)
* refactor: typescript the backends * feat: support multiple files upload for GitLab and BitBucket * fix: load entry media files from media folder or UI state * chore: cleanup log message * chore: code cleanup * refactor: typescript the test backend * refactor: cleanup getEntry unsued variables * refactor: moved shared backend code to lib util * chore: rename files to preserve history * fix: bind readFile method to API classes * test(e2e): switch to chrome in cypress tests * refactor: extract common api methods * refactor: remove most of immutable js usage from backends * feat(backend-gitlab): initial editorial workflow support * feat(backend-gitlab): implement missing workflow methods * chore: fix lint error * feat(backend-gitlab): support files deletion * test(e2e): add gitlab cypress tests * feat(backend-bitbucket): implement missing editorial workflow methods * test(e2e): add BitBucket backend e2e tests * build: update node version to 12 on netlify builds * fix(backend-bitbucket): extract BitBucket avatar url * test: fix git-gateway AuthenticationPage test * test(e2e): fix some backend tests * test(e2e): fix tests * test(e2e): add git-gateway editorial workflow test * chore: code cleanup * test(e2e): revert back to electron * test(e2e): add non editorial workflow tests * fix(git-gateway-gitlab): don't call unpublishedEntry in simple workflow gitlab git-gateway doesn't support editorial workflow APIs yet. This change makes sure not to call them in simple workflow * refactor(backend-bitbucket): switch to diffstat API instead of raw diff * chore: fix test * test(e2e): add more git-gateway tests * fix: post rebase typescript fixes * test(e2e): fix tests * fix: fix parsing of content key and add tests * refactor: rename test file * test(unit): add getStatues unit tests * chore: update cypress * docs: update beta docs
This commit is contained in:
Erez Rokah
committed by
Shawn Erquhart
Shawn Erquhart
parent
4ff5bc2ee0
commit
6f221ab3c1
@ -1,25 +1,33 @@
|
||||
const fetch = require('node-fetch');
|
||||
const {
|
||||
getGitClient,
|
||||
transformRecordedData,
|
||||
transformRecordedData: transformGitHub,
|
||||
setupGitHub,
|
||||
teardownGitHub,
|
||||
setupGitHubTest,
|
||||
teardownGitHubTest,
|
||||
} = require('./github');
|
||||
const {
|
||||
transformRecordedData: transformGitLab,
|
||||
setupGitLab,
|
||||
teardownGitLab,
|
||||
setupGitLabTest,
|
||||
teardownGitLabTest,
|
||||
} = require('./gitlab');
|
||||
const { getGitClient } = require('./common');
|
||||
|
||||
function getEnvs() {
|
||||
const {
|
||||
NETLIFY_API_TOKEN: netlifyApiToken,
|
||||
GITHUB_REPO_TOKEN: githubToken,
|
||||
GITLAB_REPO_TOKEN: gitlabToken,
|
||||
NETLIFY_INSTALLATION_ID: installationId,
|
||||
} = process.env;
|
||||
if (!netlifyApiToken) {
|
||||
throw new Error(
|
||||
'Please set NETLIFY_API_TOKEN, GITHUB_REPO_TOKEN, NETLIFY_INSTALLATION_ID environment variables',
|
||||
'Please set NETLIFY_API_TOKEN, GITHUB_REPO_TOKEN, GITLAB_REPO_TOKEN, NETLIFY_INSTALLATION_ID environment variables',
|
||||
);
|
||||
}
|
||||
return { netlifyApiToken, githubToken, installationId };
|
||||
return { netlifyApiToken, githubToken, gitlabToken, installationId };
|
||||
}
|
||||
|
||||
const apiRoot = 'https://api.netlify.com/api/v1/';
|
||||
@ -42,7 +50,7 @@ async function post(netlifyApiToken, path, payload) {
|
||||
'Content-Type': 'application/json',
|
||||
Authorization: `Bearer ${netlifyApiToken}`,
|
||||
},
|
||||
body: JSON.stringify(payload),
|
||||
...(payload ? { body: JSON.stringify(payload) } : {}),
|
||||
}).then(res => res.json());
|
||||
|
||||
return response;
|
||||
@ -68,11 +76,11 @@ async function enableIdentity(netlifyApiToken, siteId) {
|
||||
return post(netlifyApiToken, `sites/${siteId}/identity`, {});
|
||||
}
|
||||
|
||||
async function enableGitGateway(netlifyApiToken, siteId, githubToken, repo) {
|
||||
async function enableGitGateway(netlifyApiToken, siteId, provider, token, repo) {
|
||||
return post(netlifyApiToken, `sites/${siteId}/services/git/instances`, {
|
||||
github: {
|
||||
[provider]: {
|
||||
repo,
|
||||
access_token: githubToken,
|
||||
access_token: token,
|
||||
},
|
||||
});
|
||||
}
|
||||
@ -116,26 +124,101 @@ const email = 'netlifyCMS@netlify.com';
|
||||
const password = '12345678';
|
||||
const backendName = 'git-gateway';
|
||||
|
||||
const methods = {
|
||||
github: {
|
||||
setup: setupGitHub,
|
||||
teardown: teardownGitHub,
|
||||
setupTest: setupGitHubTest,
|
||||
teardownTest: teardownGitHubTest,
|
||||
transformData: transformGitHub,
|
||||
createSite: (netlifyApiToken, result) => {
|
||||
const { installationId } = getEnvs();
|
||||
return createSite(netlifyApiToken, {
|
||||
repo: {
|
||||
provider: 'github',
|
||||
installation_id: installationId,
|
||||
repo: `${result.owner}/${result.repo}`,
|
||||
},
|
||||
});
|
||||
},
|
||||
token: () => getEnvs().githubToken,
|
||||
},
|
||||
gitlab: {
|
||||
setup: setupGitLab,
|
||||
teardown: teardownGitLab,
|
||||
setupTest: setupGitLabTest,
|
||||
teardownTest: teardownGitLabTest,
|
||||
transformData: transformGitLab,
|
||||
createSite: async (netlifyApiToken, result) => {
|
||||
const { id, public_key } = await post(netlifyApiToken, 'deploy_keys');
|
||||
const { gitlabToken } = getEnvs();
|
||||
const project = `${result.owner}/${result.repo}`;
|
||||
await fetch(`https://gitlab.com/api/v4/projects/${encodeURIComponent(project)}/deploy_keys`, {
|
||||
method: 'POST',
|
||||
headers: {
|
||||
'Content-Type': 'application/json',
|
||||
Authorization: `Bearer ${gitlabToken}`,
|
||||
},
|
||||
body: JSON.stringify({ title: 'Netlify Deploy Key', key: public_key, can_push: false }),
|
||||
}).then(res => res.json());
|
||||
|
||||
const site = await createSite(netlifyApiToken, {
|
||||
account_slug: result.owner,
|
||||
repo: {
|
||||
provider: 'gitlab',
|
||||
repo: `${result.owner}/${result.repo}`,
|
||||
deploy_key_id: id,
|
||||
},
|
||||
});
|
||||
|
||||
await fetch(`https://gitlab.com/api/v4/projects/${encodeURIComponent(project)}/hooks`, {
|
||||
method: 'POST',
|
||||
headers: {
|
||||
'Content-Type': 'application/json',
|
||||
Authorization: `Bearer ${gitlabToken}`,
|
||||
},
|
||||
body: JSON.stringify({
|
||||
url: 'https://api.netlify.com/hooks/gitlab',
|
||||
push_events: true,
|
||||
merge_requests_events: true,
|
||||
enable_ssl_verification: true,
|
||||
}),
|
||||
}).then(res => res.json());
|
||||
|
||||
return site;
|
||||
},
|
||||
token: () => getEnvs().gitlabToken,
|
||||
},
|
||||
};
|
||||
|
||||
async function setupGitGateway(options) {
|
||||
const result = await setupGitHub(options);
|
||||
const { provider, ...rest } = options;
|
||||
const result = await methods[provider].setup(rest);
|
||||
|
||||
if (process.env.RECORD_FIXTURES) {
|
||||
const { netlifyApiToken, githubToken, installationId } = getEnvs();
|
||||
const { netlifyApiToken } = getEnvs();
|
||||
|
||||
console.log('Creating Netlify Site');
|
||||
const { site_id, ssl_url } = await createSite(netlifyApiToken, {
|
||||
repo: {
|
||||
provider: 'github',
|
||||
installation_id: installationId,
|
||||
repo: `${result.owner}/${result.repo}`,
|
||||
},
|
||||
});
|
||||
console.log(`Creating Netlify Site for provider: ${provider}`);
|
||||
let site_id, ssl_url;
|
||||
try {
|
||||
({ site_id, ssl_url } = await methods[provider].createSite(netlifyApiToken, result));
|
||||
} catch (e) {
|
||||
console.log(e);
|
||||
throw e;
|
||||
}
|
||||
|
||||
console.log('Enabling identity for site:', site_id);
|
||||
await enableIdentity(netlifyApiToken, site_id);
|
||||
|
||||
console.log('Enabling git gateway for site:', site_id);
|
||||
await enableGitGateway(netlifyApiToken, site_id, githubToken, `${result.owner}/${result.repo}`);
|
||||
const token = methods[provider].token();
|
||||
await enableGitGateway(
|
||||
netlifyApiToken,
|
||||
site_id,
|
||||
provider,
|
||||
token,
|
||||
`${result.owner}/${result.repo}`,
|
||||
);
|
||||
|
||||
console.log('Enabling large media for site:', site_id);
|
||||
await enableLargeMedia(netlifyApiToken, site_id);
|
||||
@ -173,6 +256,7 @@ async function setupGitGateway(options) {
|
||||
},
|
||||
site_id,
|
||||
ssl_url,
|
||||
provider,
|
||||
};
|
||||
} else {
|
||||
return {
|
||||
@ -184,6 +268,7 @@ async function setupGitGateway(options) {
|
||||
email,
|
||||
password,
|
||||
},
|
||||
provider,
|
||||
};
|
||||
}
|
||||
}
|
||||
@ -195,7 +280,7 @@ async function teardownGitGateway(taskData) {
|
||||
console.log('Deleting Netlify site:', site_id);
|
||||
await del(netlifyApiToken, `sites/${site_id}`);
|
||||
|
||||
const result = await teardownGitHub(taskData);
|
||||
const result = await methods[taskData.provider].teardown(taskData);
|
||||
return result;
|
||||
}
|
||||
|
||||
@ -204,7 +289,7 @@ async function teardownGitGateway(taskData) {
|
||||
|
||||
async function setupGitGatewayTest(taskData) {
|
||||
if (process.env.RECORD_FIXTURES) {
|
||||
const result = await setupGitHubTest(taskData);
|
||||
const result = await methods[taskData.provider].setupTest(taskData);
|
||||
return result;
|
||||
}
|
||||
|
||||
@ -215,27 +300,22 @@ async function teardownGitGatewayTest(taskData) {
|
||||
if (process.env.RECORD_FIXTURES) {
|
||||
const options = {
|
||||
transformRecordedData: (expectation, toSanitize) => {
|
||||
const result = transformRecordedData(expectation, toSanitize);
|
||||
const result = methods[taskData.provider].transformData(expectation, toSanitize);
|
||||
|
||||
const { httpRequest, httpResponse } = expectation;
|
||||
|
||||
if (
|
||||
httpResponse.body &&
|
||||
httpResponse.body.string &&
|
||||
httpRequest.path === '/.netlify/identity/token'
|
||||
) {
|
||||
let responseBody = httpResponse.body.string;
|
||||
const parsed = JSON.parse(responseBody);
|
||||
if (httpResponse.body && httpRequest.path === '/.netlify/identity/token') {
|
||||
const parsed = JSON.parse(httpResponse.body);
|
||||
parsed.access_token = 'access_token';
|
||||
parsed.refresh_token = 'refresh_token';
|
||||
responseBody = JSON.stringify(parsed);
|
||||
const responseBody = JSON.stringify(parsed);
|
||||
return { ...result, response: responseBody };
|
||||
} else {
|
||||
return result;
|
||||
}
|
||||
},
|
||||
};
|
||||
const result = await teardownGitHubTest(taskData, options);
|
||||
const result = await methods[taskData.provider].teardownTest(taskData, options);
|
||||
return result;
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user