({
39 | name: "AspectRegistrations",
40 | variables: {
41 | name: !!name ? [name] : undefined,
42 | },
43 | }));
44 | return !!aspects ? aspects.AspectRegistration : [];
45 | }
46 |
47 | /**
48 | * Register aspect report details on start up
49 | */
50 | export function registerAspects(sdm: SoftwareDeliveryMachine,
51 | allAspects: Aspect[]): StartupListener {
52 | return async () => {
53 | // Only run this on the cluster master if cluster mode is enabled
54 | if (sdm.configuration.cluster.enabled && !cluster.isMaster) {
55 | return;
56 | }
57 |
58 | const workspaceIds = sdm.configuration.workspaceIds;
59 | const aspects = allAspects.filter(hasReportDetails);
60 |
61 | for (const workspaceId of workspaceIds) {
62 |
63 | // Set up graphql and message clients
64 | const messageClient = new TriggeredMessageClient(
65 | (sdm.configuration.ws as any).lifecycle,
66 | workspaceId,
67 | sdm.configuration) as any;
68 | const graphClient = sdm.configuration.graphql.client.factory.create(workspaceId, sdm.configuration);
69 |
70 | const registeredAspects = await getAspectRegistrations({ graphClient });
71 |
72 | for (const aspect of aspects) {
73 | const details = aspect.details;
74 | const registeredAspect = registeredAspects.find(a => a.name === aspect.name && a.owner === sdm.configuration.name);
75 |
76 | const aspectRegistration: AspectRegistrations.AspectRegistration = {
77 | name: aspect.name,
78 | owner: sdm.configuration.name,
79 | displayName: aspect.displayName,
80 | unit: details.unit,
81 | shortName: details.shortName,
82 | description: details.description,
83 | category: details.category,
84 | url: details.url,
85 | manageable: details.manage !== undefined ? details.manage : !!aspect.apply,
86 | state: !!registeredAspect && !!registeredAspect.state ? registeredAspect.state : AspectRegistrationState.Enabled,
87 | };
88 |
89 | await messageClient.send(aspectRegistration, addressEvent("AspectRegistration"));
90 | }
91 | }
92 | };
93 | }
94 |
95 | class TriggeredMessageClient extends AbstractWebSocketMessageClient {
96 |
97 | constructor(ws: WebSocketLifecycle,
98 | workspaceId: string,
99 | configuration: Configuration) {
100 | super(ws, {} as any, guid(), { id: workspaceId }, {} as any, configuration);
101 | }
102 | }
103 |
--------------------------------------------------------------------------------
/lib/routes/web-app/overviewPage.ts:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright © 2019 Atomist, Inc.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | import { logger } from "@atomist/automation-client";
18 | import {
19 | Aspect,
20 | supportsEntropy,
21 | } from "@atomist/sdm-pack-fingerprint";
22 | import * as _ from "lodash";
23 | import {
24 | AspectFingerprintsForDisplay,
25 | FingerprintForDisplay,
26 | Overview,
27 | } from "../../../views/overview";
28 | import { renderStaticReactNode } from "../../../views/topLevelPage";
29 | import { ConnectionErrorHeading } from "../../analysis/offline/persist/pgClientFactory";
30 | import { FingerprintUsage } from "../../analysis/offline/persist/ProjectAnalysisResultStore";
31 | import { defaultedToDisplayableFingerprintName } from "../../aspect/DefaultAspectRegistry";
32 | import { WebAppConfig } from "./webAppConfig";
33 |
34 | export function exposeOverviewPage(conf: WebAppConfig,
35 | topLevelRoute: string): void {
36 | conf.express.get(topLevelRoute, ...conf.handlers, async (req, res, next) => {
37 | try {
38 | const repos = await conf.store.loadInWorkspace(req.query.workspace || req.params.workspace_id, false);
39 | const workspaceId = "local";
40 | const fingerprintUsage = await conf.store.fingerprintUsageForType(workspaceId);
41 |
42 | const aspectsEligibleForDisplay = conf.aspectRegistry.aspects
43 | .filter(a => !!a.displayName)
44 | .filter(a => fingerprintUsage.some(fu => fu.type === a.name));
45 | const foundAspects: AspectFingerprintsForDisplay[] = _.sortBy(aspectsEligibleForDisplay, a => a.displayName)
46 | .map(aspect => {
47 | const fingerprintsForThisAspect = fingerprintUsage.filter(fu => fu.type === aspect.name);
48 | return {
49 | aspect,
50 | fingerprints: fingerprintsForThisAspect
51 | .map(fp => formatFingerprintUsageForDisplay(aspect, fp)),
52 | };
53 | });
54 |
55 | const unfoundAspects: Aspect[] = conf.aspectRegistry.aspects
56 | .filter(f => !!f.displayName)
57 | .filter(f => !fingerprintUsage.some(fu => fu.type === f.name));
58 | const virtualProjectCount = await conf.store.virtualProjectCount(workspaceId);
59 |
60 | res.send(renderStaticReactNode(
61 | Overview({
62 | projectsAnalyzed: repos.length,
63 | foundAspects,
64 | unfoundAspects,
65 | repos: repos.map(r => ({
66 | id: r.id,
67 | repo: r.repoRef.repo,
68 | owner: r.repoRef.owner,
69 | url: r.repoRef.url,
70 | })),
71 | virtualProjectCount,
72 | }), `Atomist Visualizer (${repos.length} repositories)`,
73 | conf.instanceMetadata));
74 | } catch (e) {
75 | logger.error(e.stack);
76 | res.status(500).send(cleverlyExplainError(conf, e));
77 | }
78 | });
79 | }
80 |
81 | const ReadmeLink = "https://github.com/atomist/org-visualizer/#database-setup";
82 |
83 | function cleverlyExplainError(conf: WebAppConfig, e: Error): string {
84 | if (e.message.includes(ConnectionErrorHeading) || e.message.includes("ENOCONNECT")) {
85 | return `This page cannot load without a database connection.
86 | Please check the org-visualizer README for how to set up a database.
87 | Error:
${e.message}`;
88 | }
89 | return `Failed to load page. Please check the log output of ${conf.instanceMetadata.name}`;
90 | }
91 |
92 | function formatFingerprintUsageForDisplay(aspect: Aspect, fp: FingerprintUsage): FingerprintForDisplay {
93 | return {
94 | ...fp,
95 | displayName: defaultedToDisplayableFingerprintName(aspect)(fp.name),
96 | entropy: supportsEntropy(aspect) ? fp.entropy : undefined,
97 | };
98 | }
99 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contributing to Atomist open source projects
2 |
3 | Have something you would like to contribute to this project? Awesome,
4 | and thanks for taking time to contribute! Here's what you need to
5 | know.
6 |
7 | ## Contributing code
8 |
9 | Is there an improvement to existing functionality or an entirely new
10 | feature you would like to see? Before creating enhancement
11 | suggestions, please check the issue list as you might find out that
12 | you don't need to create one.
13 |
14 | Did you know we have a [Slack community][slack]? This might be a
15 | great place to talk through your idea before starting. It allows you
16 | to see if anyone else is already working on something similar, having
17 | the same issue or to get feedback on your enhancement idea.
18 | Discussing things with the community first is likely to make the
19 | contribution process a better experience for yourself and those that
20 | are maintaining the projects.
21 |
22 | [slack]: https://join.atomist.com/
23 |
24 | If you do not find an open issue related to your contribution and
25 | discussions in the Slack community are positive, the next thing to do
26 | is to create an issue in the appropriate GitHub repository.
27 |
28 | * Before we can accept any code changes into the Atomist codebase,
29 | we need to get some of the legal stuff covered. This is pretty
30 | standard for open-source projects. We are using
31 | [cla-assisant.io][cla-assistant] to track our Contributor License
32 | Agreement (CLA) signatures. If you have not signed a CLA for the
33 | repository to which you are contributing, you will be prompted to
34 | when you create a pull request (PR).
35 | * Be sure there is an open issue related to the contribution.
36 | * Code contributions should successfully build and pass tests.
37 | * Commit messages should follow the [standard format][commit] and
38 | should include a [reference][ref] to the open issue they are
39 | addressing.
40 | * All code contributions should be submitted via
41 | a [pull request (PR) from a forked GitHub repository][pr].
42 | * Your PR will be reviewed by an Atomist developer.
43 |
44 | [cla-assistant]: https://cla-assistant.io/
45 | [commit]: http://chris.beams.io/posts/git-commit/
46 | [ref]: https://github.com/blog/957-introducing-issue-mentions
47 | [pr]: https://guides.github.com/activities/contributing-to-open-source/
48 |
49 | ## Reporting problems
50 |
51 | Please go through the checklist below before reporting a
52 | problem. There's a chance it may have already been reported, or
53 | resolved.
54 |
55 | * Check if you can reproduce the problem in the latest version of
56 | the project.
57 | * Search the [atomist-community Slack][slack] community for common
58 | questions and problems.
59 | * Understand which repo the bug should be reported in.
60 | * Scan the list of issues to see if the problem has previously been
61 | reported. If so, you may add a comment to the existing issue
62 | rather than creating a new one.
63 |
64 | You went through the list above and it is still something you would
65 | like to report? Then, please provide us with as much of the context,
66 | by explaininig the problem and including any additional details that
67 | would help maintainers reproduce the problem. The more details you
68 | provide in the bug report, the better.
69 |
70 | Bugs are tracked as GitHub issues. After you've determined which
71 | repository your bug is related to, create an issue on that repository
72 | and provide as much information as possible. Feel free to use
73 | the bug report template below if you like.
74 |
75 | At a minimum include the following:
76 |
77 | * Where did you find the bug? For example, did you encounter the bug
78 | in chat, the CLI, somewhere else?
79 | * What version are you using?
80 | * What command were you using when it happened? (including
81 | parameters where applicable)
82 |
83 | ```
84 | [Description of the problem]
85 |
86 | **How to Reproduce:**
87 |
88 | 1. [First Step]
89 | 2. [Second Step]
90 | 3. [n Step]
91 |
92 | **Expected behavior:**
93 |
94 | [Describe expected behavior here]
95 |
96 | **Observed behavior:**
97 |
98 | [Describe observed behavior here]
99 |
100 | **Screenshots and GIFs**
101 |
102 | 
103 |
104 | **Project version:** [Enter project version]
105 | **Atomist CLI version:** [Enter CLI version]
106 | ```
107 |
108 | This project adheres to the Contributor Covenant [code of
109 | conduct][conduct]. By participating, you are expected to uphold this
110 | code. Please report unacceptable behavior to
111 | [code-of-conduct@atomist.com][email].
112 |
113 | [conduct]: CODE_OF_CONDUCT.md
114 | [email]: mailto:code-of-conduct@atomist.com
115 |
--------------------------------------------------------------------------------
/lib/analysis/offline/spider/local/LocalSpider.ts:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright © 2019 Atomist, Inc.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | import {
18 | GitCommandGitProject,
19 | GitProject,
20 | logger,
21 | RepoId,
22 | RepoRef,
23 | } from "@atomist/automation-client";
24 | import { execPromise } from "@atomist/sdm";
25 | import * as fs from "fs-extra";
26 | import * as path from "path";
27 | import { AnalysisTracker } from "../../../tracking/analysisTracker";
28 | import {
29 | AnalysisRun,
30 | } from "../common";
31 | import { ScmSearchCriteria } from "../ScmSearchCriteria";
32 | import {
33 | Analyzer,
34 | Spider,
35 | SpiderOptions,
36 | SpiderResult,
37 | } from "../Spider";
38 |
39 | export class LocalSpider implements Spider {
40 |
41 | public async spider(criteria: ScmSearchCriteria,
42 | analyzer: Analyzer,
43 | analysisTracking: AnalysisTracker,
44 | opts: SpiderOptions,
45 | ): Promise {
46 |
47 | const go = new AnalysisRun({
48 | howToFindRepos: () => findRepositoriesUnder(this.localDirectory),
49 | determineRepoRef: repoRefFromLocalRepo,
50 | describeFoundRepo: f => ({ description: f.replace(this.localDirectory, "") }),
51 | howToClone: (rr, fr) => GitCommandGitProject.fromExistingDirectory(rr, fr) as Promise,
52 | analyzer,
53 | analysisTracking,
54 | persister: opts.persister,
55 |
56 | keepExistingPersisted: opts.keepExistingPersisted,
57 | projectFilter: criteria.projectTest,
58 | }, {
59 | workspaceId: opts.workspaceId,
60 | description: "local analysis under " + this.localDirectory,
61 | maxRepos: 1000,
62 | poolSize: opts.poolSize,
63 | });
64 |
65 | return go.run();
66 | }
67 |
68 | constructor(public readonly localDirectory: string) {
69 | }
70 | }
71 |
72 | async function* findRepositoriesUnder(dir: string): AsyncIterable {
73 | try {
74 | const stat = await fs.stat(await fs.realpath(dir));
75 | if (!stat.isDirectory()) {
76 | // nothing interesting
77 | return;
78 | }
79 | } catch (err) {
80 | logger.error("Error opening " + dir + ": " + err.message);
81 | return;
82 | }
83 |
84 | const dirContents = await fs.readdir(dir);
85 | if (dirContents.includes(".git")) {
86 | // this is the repository you are looking for
87 | yield dir;
88 | return;
89 | }
90 |
91 | // recurse over everything inside
92 | for (const d of dirContents) {
93 | for await (const dd of findRepositoriesUnder(path.join(dir, d))) {
94 | yield dd;
95 | }
96 | }
97 | }
98 |
99 | /**
100 | * @param repoDir full path to repository
101 | */
102 | async function repoRefFromLocalRepo(repoDir: string): Promise {
103 | const repoId: RepoId = await execPromise("git", ["remote", "get-url", "origin"], { cwd: repoDir })
104 | .then(execHappened => repoIdFromOriginUrl(execHappened.stdout))
105 | .catch(() => inventRepoId(repoDir));
106 |
107 | const sha = await execPromise("git", ["rev-parse", "HEAD"], { cwd: repoDir })
108 | .then(execHappened => execHappened.stdout.trim())
109 | .catch(() => "unknown");
110 |
111 | return {
112 | ...repoId,
113 | sha,
114 | };
115 | }
116 |
117 | function repoIdFromOriginUrl(originUrl: string): RepoId {
118 | const parse = /\/(?.+)\/(?.+)(.git)?$/.exec(originUrl);
119 |
120 | if (!parse) {
121 | throw new Error("Can't identify owner and repo in url: " + originUrl);
122 | }
123 |
124 | return {
125 | repo: parse.groups.repo,
126 | owner: parse.groups.owner,
127 | url: originUrl,
128 | };
129 | }
130 |
131 | function inventRepoId(repoDir: string): RepoId {
132 | const { base, dir } = path.parse(repoDir);
133 | const repo = base;
134 | const owner = path.parse(dir).base || "pretendOwner";
135 |
136 | return {
137 | repo,
138 | owner,
139 | url: "file://" + repoDir,
140 | };
141 | }
142 |
--------------------------------------------------------------------------------
/test/aspect/fileMatchAspect.test.ts:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright © 2019 Atomist, Inc.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | import { InMemoryProject } from "@atomist/automation-client";
18 | import {
19 | FileMatchData,
20 | } from "../../lib/aspect/compose/fileMatchAspect";
21 |
22 | import * as assert from "assert";
23 |
24 | import { microgrammar } from "@atomist/microgrammar";
25 | import { FP } from "@atomist/sdm-pack-fingerprint";
26 | import { microgrammarMatchAspect } from "../../lib/aspect/compose/microgrammarMatchAspect";
27 |
28 | // tslint:disable
29 |
30 | describe("fileMatchAspect", () => {
31 |
32 | describe("microgrammarMatchAspect", () => {
33 |
34 | it("should not match in empty project", async () => {
35 | const p = InMemoryProject.of();
36 | const aspect = microgrammarMatchAspect({
37 | name: "foo",
38 | displayName: "foo",
39 | glob: "thing",
40 | grammar: microgrammar({
41 | name: /.*/,
42 | }),
43 | path: "name",
44 | });
45 | const r = await aspect.extract(p, undefined) as FP;
46 | assert(r !== undefined);
47 | assert.strictEqual(r.data.matches.length, 0, JSON.stringify(r));
48 | });
49 |
50 | it("should not match in file with no match", async () => {
51 | const p = InMemoryProject.of({
52 | path: "thing",
53 | content: "whatever",
54 | });
55 | const aspect = microgrammarMatchAspect({
56 | name: "foo",
57 | displayName: "foo",
58 | glob: "thing",
59 | grammar: microgrammar({
60 | name: "_",
61 | age: /[0-9]+/,
62 | end: "_",
63 | }),
64 | path: "age",
65 | });
66 | const r = await aspect.extract(p, undefined) as FP;
67 | assert(r !== undefined);
68 | assert.strictEqual(r.data.matches.length, 0, JSON.stringify(r));
69 | });
70 |
71 | it("should match in file with match", async () => {
72 | const p = InMemoryProject.of({
73 | path: "thing",
74 | content: "_25_",
75 | });
76 | const aspect = microgrammarMatchAspect({
77 | name: "foo",
78 | displayName: "foo",
79 | glob: "thing",
80 | grammar: microgrammar({
81 | name: "_",
82 | age: /[0-9]+/,
83 | end: "_",
84 | }),
85 | path: "age",
86 | });
87 | const r = await aspect.extract(p, undefined) as FP;
88 | assert.strictEqual(r.data.matches.length, 1);
89 | assert.strictEqual(r.data.matches[0].matchValue, "25");
90 | });
91 |
92 | it("should match real world example", async () => {
93 | const content = `
94 |
95 |
96 | Exe
97 | netcoreapp2.2
98 |
99 |
100 | `;
101 |
102 | const grammar = microgrammar({
103 | _open: //,
104 | targetFramework: /[a-zA-Z0-9_;/.]+/,
105 | _close: /<\/TargetFrameworks?>/,
106 | });
107 |
108 | const parsed = grammar.findMatches(content);
109 | assert.strictEqual(parsed.length, 1);
110 |
111 | const p = InMemoryProject.of({
112 | path: "thing.csproj",
113 | content,
114 | });
115 | const aspect = microgrammarMatchAspect({
116 | name: "foo",
117 | displayName: "foo",
118 | glob: "*.csproj",
119 | grammar,
120 | path: "targetFramework",
121 | });
122 | const r = await aspect.extract(p, undefined) as FP;
123 | assert.strictEqual(r.data.matches.length, 1);
124 | assert.strictEqual(r.data.matches[0].matchValue, "netcoreapp2.2");
125 | });
126 | });
127 |
128 | });
129 |
--------------------------------------------------------------------------------
40 |
41 | {props.pageTitle}
42 |
43 |
44 |