/
PushTest.ts
67 lines (60 loc) · 1.89 KB
/
PushTest.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
/*
* Copyright © 2018 Atomist, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Project } from "@atomist/automation-client";
import { PushListenerInvocation } from "../listener/PushListener";
import { PredicateMapping } from "./PredicateMapping";
/**
* Special PushMapping. Return true if we like this push. Used in goal setting etc.
*/
export interface PushTest extends PredicateMapping<PushListenerInvocation> {
}
/**
* Test against a project
*/
export type ProjectPredicate = (p: Project) => Promise<boolean>;
/**
* Convenient factory function for PushTest instances
* @param {string} name
* @param mapping test function
* @return {PushTest}
*/
export function pushTest(name: string, mapping: (p: PushListenerInvocation) => Promise<boolean>): PushTest {
return {
name,
mapping,
};
}
/**
* PushTest that also exposes the ProjectPredicate it is
* based on
*/
export interface PredicatePushTest extends PushTest {
predicate: ProjectPredicate;
}
/**
* Convenient factory function for PushTest instances based on project predicates.
* Also exposes project predicate
* @param {string} name
* @param predicate test function for projects
* @return {PushTest}
*/
export function predicatePushTest(name: string, predicate: ProjectPredicate): PredicatePushTest {
return {
name,
mapping: pli => predicate(pli.project),
predicate,
};
}