2.2.131 • Published 5 months ago

@salesforce/source-testkit v2.2.131

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
5 months ago

NPM Downloads/week License

Description

The @salesforce/source-testkit library wraps around @salesforce/cli-plugins-testkit to provide a simple interface for Salesforce CLI plug-in authors to compose source (e.g. deploy, retrieve, push, and pull) related non-unit-tests (NUTs).

Specifically, SourceTestKit provides the following conveniences:

  1. Wrapper methods for the source CLI commands. For example, the force:source:deploy and force:source:retrieve commands can be invoked like so:
    const sourceTestkit = await SourceTestkit.create({
      repository: 'https://github.com/trailheadapps/dreamhouse-lwc.git',
      nut: __filename,
    });
    sourceTestkit.deploy({ args: `--sourcepath force-app` });
    sourceTestkit.retrieve({ args: `--sourcepath force-app` });
  2. Common assertions like expecting a file to be deployed or expecting a file to be retrieved. These are all accessible under sourceTestkit.expect. For example:
    const sourceTestkit = await SourceTestkit.create({
      repository: 'https://github.com/trailheadapps/dreamhouse-lwc.git',
      nut: __filename,
    });
    sourceTestkit.deploy({ args: `--sourcepath force-app` });
    sourceTestkit.expect.filesToBeDeployed('force-app/**/*');
    NOTE When providing files paths to these assertion methods, you need to provide a glob pattern, NOT an OS specific file path. We have chosen this approach because it provides a lot of flexibility when writing tests and because it's OS agnostic.

Usage

Add this library as a dev dependencies to your project.

yarn add @salesforcecli/source-testkit --dev

Examples

import { SourceTestkit } from '@salesforce/source-testkit';

context('Deploy from source path NUT', () => {
  let sourceTestkit: SourceTestkit;

  before(async () => {
    sourceTestkit = await SourceTestkit.create({
      repository: 'https://github.com/trailheadapps/dreamhouse-lwc.git',
      nut: __filename,
    });
  });

  after(async () => {
    await sourceTestkit?.clean();
  });

  describe('--sourcepath flag', () => {
    it(`should deploy force-app`, async () => {
      await sourceTestkit.deploy({ args: '--sourcepath force-app' });
      await sourceTestkit.expect.filesToBeDeployed(['force-app/**/*']);
    });

    it('should throw an error if the sourcepath is not valid', async () => {
      const deploy = await sourceTestkit.deploy({ args: '--sourcepath DOES_NOT_EXIST', exitCode: 1 });
      sourceTestkit.expect.errorToHaveName(deploy, 'SourcePathInvalid');
    });
  });
});
2.2.120

6 months ago

2.2.124

5 months ago

2.2.123

6 months ago

2.2.122

6 months ago

2.2.121

6 months ago

2.2.128

5 months ago

2.2.127

5 months ago

2.2.126

5 months ago

2.2.125

5 months ago

2.2.119

6 months ago

2.2.118

6 months ago

2.2.113

7 months ago

2.2.112

7 months ago

2.2.111

7 months ago

2.2.110

7 months ago

2.2.117

6 months ago

2.2.116

7 months ago

2.2.115

7 months ago

2.2.114

7 months ago

2.2.109

7 months ago

2.2.108

7 months ago

2.2.107

7 months ago

2.2.131

5 months ago

2.2.130

5 months ago

2.2.129

5 months ago

2.2.88

11 months ago

2.2.89

11 months ago

2.2.86

12 months ago

2.2.87

11 months ago

2.2.85

12 months ago

2.2.90

11 months ago

2.2.99

9 months ago

2.2.97

9 months ago

2.2.98

9 months ago

2.2.95

10 months ago

2.2.96

10 months ago

2.2.93

10 months ago

2.2.94

10 months ago

2.2.91

11 months ago

2.2.92

10 months ago

2.2.102

8 months ago

2.2.101

8 months ago

2.2.100

9 months ago

2.2.106

8 months ago

2.2.105

8 months ago

2.2.104

8 months ago

2.2.103

8 months ago

2.2.84

12 months ago

2.2.83

12 months ago

2.2.82

12 months ago

2.2.81

12 months ago

2.2.79

1 year ago

2.2.80

1 year ago

2.2.77

1 year ago

2.2.78

1 year ago

2.2.75

1 year ago

2.2.76

1 year ago

2.2.73

1 year ago

2.2.74

1 year ago

2.2.72

1 year ago

2.2.69

1 year ago

2.2.71

1 year ago

2.2.70

1 year ago

2.2.68

1 year ago

2.2.67

1 year ago

2.2.66

1 year ago

2.2.65

1 year ago

2.2.64

1 year ago

2.2.63

1 year ago

2.2.62

1 year ago

2.2.61

1 year ago

2.2.59

1 year ago

2.2.57

1 year ago

2.2.58

1 year ago

2.2.55

1 year ago

2.2.56

1 year ago

2.2.53

1 year ago

2.2.54

1 year ago

2.2.51

1 year ago

2.2.52

1 year ago

2.2.50

1 year ago

2.2.60

1 year ago

2.2.17

1 year ago

2.2.18

1 year ago

2.2.19

1 year ago

2.2.28

1 year ago

2.2.29

1 year ago

2.2.26

1 year ago

2.2.27

1 year ago

2.2.24

1 year ago

2.2.25

1 year ago

2.2.22

1 year ago

2.2.23

1 year ago

2.2.20

1 year ago

2.2.21

1 year ago

2.2.39

1 year ago

2.2.37

1 year ago

2.2.38

1 year ago

2.2.35

1 year ago

2.2.36

1 year ago

2.2.33

1 year ago

2.2.34

1 year ago

2.2.31

1 year ago

2.2.32

1 year ago

2.2.30

1 year ago

2.2.48

1 year ago

2.2.49

1 year ago

2.2.46

1 year ago

2.2.47

1 year ago

2.2.44

1 year ago

2.2.45

1 year ago

2.2.42

1 year ago

2.2.43

1 year ago

2.2.40

1 year ago

2.2.41

1 year ago

2.2.15

1 year ago

2.2.16

1 year ago

2.2.14

1 year ago

2.2.13

1 year ago

2.2.11

1 year ago

2.2.12

1 year ago

2.2.10

1 year ago

2.2.9

1 year ago

2.2.8

1 year ago

2.2.7

1 year ago

2.2.6

1 year ago

2.2.3

2 years ago

2.2.2

2 years ago

2.2.5

2 years ago

2.2.4

2 years ago

2.2.1

2 years ago

2.2.0

2 years ago

2.1.114

2 years ago

2.1.113

2 years ago

2.1.112

2 years ago

2.1.111

2 years ago

2.1.109

2 years ago

2.1.110

2 years ago

2.1.107

2 years ago

2.1.106

2 years ago

2.1.108

2 years ago

2.1.105

2 years ago

2.1.104

2 years ago

2.1.103

2 years ago

2.1.102

2 years ago

2.1.101

2 years ago

2.1.100

2 years ago

2.1.98

2 years ago

2.1.99

2 years ago

2.1.97

2 years ago

2.1.96

2 years ago

2.1.95

2 years ago

2.1.94

2 years ago

2.1.93

2 years ago

2.1.92

2 years ago

2.1.91

2 years ago

2.1.89

2 years ago

2.1.90

2 years ago

2.1.87

2 years ago

2.1.88

2 years ago

2.1.85

2 years ago

2.1.86

2 years ago

2.1.84

2 years ago

2.1.83

2 years ago

2.1.82

2 years ago

2.1.81

2 years ago

2.1.80

2 years ago

2.1.78

2 years ago

2.1.79

2 years ago

2.1.77

2 years ago

2.1.76

2 years ago

2.1.74

2 years ago

2.1.75

2 years ago

2.1.73

2 years ago

2.1.72

2 years ago

2.1.70

2 years ago

2.1.71

2 years ago

2.1.9

2 years ago

2.1.16

2 years ago

2.1.17

2 years ago

2.1.14

2 years ago

2.1.15

2 years ago

2.1.12

2 years ago

2.1.13

2 years ago

2.1.10

2 years ago

2.1.11

2 years ago

2.1.18

2 years ago

2.1.19

2 years ago

2.1.27

2 years ago

2.1.28

2 years ago

2.1.25

2 years ago

2.1.26

2 years ago

2.1.23

2 years ago

2.1.24

2 years ago

2.1.21

2 years ago

2.1.22

2 years ago

2.1.20

2 years ago

2.1.29

2 years ago

2.1.38

2 years ago

2.1.39

2 years ago

2.1.36

2 years ago

2.1.37

2 years ago

2.1.34

2 years ago

2.1.35

2 years ago

2.1.32

2 years ago

2.1.33

2 years ago

2.1.30

2 years ago

2.1.31

2 years ago

2.1.49

2 years ago

2.1.47

2 years ago

2.1.48

2 years ago

2.1.45

2 years ago

2.1.46

2 years ago

2.1.43

2 years ago

2.1.44

2 years ago

2.1.41

2 years ago

2.1.42

2 years ago

2.1.40

2 years ago

2.1.58

2 years ago

2.1.59

2 years ago

2.1.56

2 years ago

2.1.57

2 years ago

2.1.54

2 years ago

2.1.55

2 years ago

2.1.52

2 years ago

2.1.53

2 years ago

2.1.50

2 years ago

2.1.51

2 years ago

2.1.69

2 years ago

2.1.67

2 years ago

2.1.68

2 years ago

2.1.65

2 years ago

2.1.66

2 years ago

2.1.63

2 years ago

2.1.64

2 years ago

2.1.61

2 years ago

2.1.62

2 years ago

2.1.60

2 years ago

2.0.59

2 years ago

2.0.62

2 years ago

2.0.63

2 years ago

2.0.60

2 years ago

2.0.61

2 years ago

2.1.2

2 years ago

2.1.1

2 years ago

2.1.4

2 years ago

2.1.3

2 years ago

2.1.6

2 years ago

2.1.5

2 years ago

2.1.8

2 years ago

2.1.7

2 years ago

2.1.0

2 years ago

2.0.48

3 years ago

2.0.49

3 years ago

2.0.46

3 years ago

2.0.47

3 years ago

2.0.44

3 years ago

2.0.45

3 years ago

2.0.42

3 years ago

2.0.43

3 years ago

2.0.41

3 years ago

2.0.57

2 years ago

2.0.58

2 years ago

2.0.55

3 years ago

2.0.56

3 years ago

2.0.53

3 years ago

2.0.54

3 years ago

2.0.51

3 years ago

2.0.52

3 years ago

2.0.50

3 years ago

2.0.37

3 years ago

2.0.38

3 years ago

2.0.39

3 years ago

2.0.40

3 years ago

2.0.28

3 years ago

2.0.29

3 years ago

2.0.35

3 years ago

2.0.36

3 years ago

2.0.33

3 years ago

2.0.34

3 years ago

2.0.31

3 years ago

2.0.32

3 years ago

2.0.30

3 years ago

2.0.26

3 years ago

2.0.27

3 years ago

2.0.24

3 years ago

2.0.25

3 years ago

2.0.23

3 years ago

2.0.3

3 years ago

2.0.2

3 years ago

2.0.5

3 years ago

2.0.4

3 years ago

2.0.7

3 years ago

2.0.6

3 years ago

2.0.9

3 years ago

2.0.8

3 years ago

2.0.1

3 years ago

2.0.0

3 years ago

1.2.16

3 years ago

1.2.17

3 years ago

1.2.15

3 years ago

2.0.15

3 years ago

2.0.16

3 years ago

2.0.13

3 years ago

2.0.14

3 years ago

2.0.11

3 years ago

2.0.12

3 years ago

2.0.10

3 years ago

2.0.19

3 years ago

2.0.17

3 years ago

2.0.18

3 years ago

2.0.22

3 years ago

2.0.20

3 years ago

2.0.21

3 years ago

1.2.8

3 years ago

1.2.9

3 years ago

1.2.12

3 years ago

1.2.13

3 years ago

1.2.10

3 years ago

1.2.11

3 years ago

1.2.14

3 years ago

1.2.7

3 years ago

1.2.6

3 years ago

1.2.5

3 years ago

1.2.4

3 years ago

1.2.3

3 years ago

1.2.2

3 years ago

1.2.1

3 years ago

1.2.0

3 years ago

1.1.1

3 years ago

1.0.2

3 years ago

1.1.0

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago

0.0.18

4 years ago

0.0.17

4 years ago

0.0.16

4 years ago

0.0.15

4 years ago

0.0.14

4 years ago

0.0.12

4 years ago

0.0.13

4 years ago

0.0.11

4 years ago

0.0.10

4 years ago

0.0.9

4 years ago

0.0.8

4 years ago

0.0.7

4 years ago

0.0.6

4 years ago

0.0.5

4 years ago

0.0.4

4 years ago

0.0.3

4 years ago

0.0.2

4 years ago

0.0.1

4 years ago