@locusqa/runner 0.0.0-stage → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,105 @@
1
+ # Functional Source License, Version 1.1, ALv2 Future License
2
+
3
+ ## Abbreviation
4
+
5
+ FSL-1.1-ALv2
6
+
7
+ ## Notice
8
+
9
+ Copyright 2026 Rifaudeen Ahamed Mohaideen
10
+
11
+ ## Terms and Conditions
12
+
13
+ ### Licensor ("We")
14
+
15
+ The party offering the Software under these Terms and Conditions.
16
+
17
+ ### The Software
18
+
19
+ The "Software" is each version of the software that we make available under
20
+ these Terms and Conditions, as indicated by our inclusion of these Terms and
21
+ Conditions with the Software.
22
+
23
+ ### License Grant
24
+
25
+ Subject to your compliance with this License Grant and the Patents,
26
+ Redistribution and Trademark clauses below, we hereby grant you the right to
27
+ use, copy, modify, create derivative works, publicly perform, publicly display
28
+ and redistribute the Software for any Permitted Purpose identified below.
29
+
30
+ ### Permitted Purpose
31
+
32
+ A Permitted Purpose is any purpose other than a Competing Use. A Competing Use
33
+ means making the Software available to others in a commercial product or
34
+ service that:
35
+
36
+ 1. substitutes for the Software;
37
+
38
+ 2. substitutes for any other product or service we offer using the Software
39
+ that exists as of the date we make the Software available; or
40
+
41
+ 3. offers the same or substantially similar functionality as the Software.
42
+
43
+ Permitted Purposes specifically include using the Software:
44
+
45
+ 1. for your internal use and access;
46
+
47
+ 2. for non-commercial education;
48
+
49
+ 3. for non-commercial research; and
50
+
51
+ 4. in connection with professional services that you provide to a licensee
52
+ using the Software in accordance with these Terms and Conditions.
53
+
54
+ ### Patents
55
+
56
+ To the extent your use for a Permitted Purpose would necessarily infringe our
57
+ patents, the license grant above includes a license under our patents. If you
58
+ make a claim against any party that the Software infringes or contributes to
59
+ the infringement of any patent, then your patent license to the Software ends
60
+ immediately.
61
+
62
+ ### Redistribution
63
+
64
+ The Terms and Conditions apply to all copies, modifications and derivatives of
65
+ the Software.
66
+
67
+ If you redistribute any copies, modifications or derivatives of the Software,
68
+ you must include a copy of or a link to these Terms and Conditions and not
69
+ remove any copyright notices provided in or with the Software.
70
+
71
+ ### Disclaimer
72
+
73
+ THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR
74
+ IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR
75
+ PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
76
+
77
+ IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE
78
+ SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES,
79
+ EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
80
+
81
+ ### Trademarks
82
+
83
+ Except for displaying the License Details and identifying us as the origin of
84
+ the Software, you have no right under these Terms and Conditions to use our
85
+ trademarks, trade names, service marks or product names.
86
+
87
+ ## Grant of Future License
88
+
89
+ We hereby irrevocably grant you an additional license to use the Software under
90
+ the Apache License, Version 2.0 that is effective on the second anniversary of
91
+ the date we make the Software available. On or after that date, you may use the
92
+ Software under the Apache License, Version 2.0, in which case the following
93
+ will apply:
94
+
95
+ Licensed under the Apache License, Version 2.0 (the "License"); you may not use
96
+ this file except in compliance with the License.
97
+
98
+ You may obtain a copy of the License at
99
+
100
+ http://www.apache.org/licenses/LICENSE-2.0
101
+
102
+ Unless required by applicable law or agreed to in writing, software distributed
103
+ under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
104
+ CONDITIONS OF ANY KIND, either express or implied. See the License for the
105
+ specific language governing permissions and limitations under the License.
package/README.md CHANGED
@@ -1,3 +1,51 @@
1
- # Temporary Holding Version
1
+ # locus-runner
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ The customer-run test runner for Locus. It runs your recorded test cases on your own machine or
4
+ CI, so it can reach staging servers, localhost and private networks, and sends the results to
5
+ your Locus workspace.
6
+
7
+ ## Install
8
+
9
+ ```bash
10
+ npm install --global @locusqa/runner
11
+ npx playwright install chromium
12
+ ```
13
+
14
+ Needs Node 20 or newer. The runner uses Playwright, which downloads its own browser.
15
+
16
+ ## Use
17
+
18
+ ```bash
19
+ # Stay connected and run the runs you start from the Locus dashboard
20
+ locus-runner listen --base-url "https://api.locusqa.com" --token "$RUNNER_TOKEN"
21
+
22
+ # Run once, for example in CI, and write a JUnit report
23
+ locus-runner run --base-url "https://api.locusqa.com" --token "$RUNNER_TOKEN" \
24
+ --site "<site_id>" --env "<env_slug>" --all --junit locus-junit.xml
25
+ ```
26
+
27
+ Create the token in the Locus dashboard under Settings, API tokens, with the Runner role.
28
+ Run `locus-runner --help` for every option.
29
+
30
+ ## About the source
31
+
32
+ The package ships the readable bundle and a source map that contains the original TypeScript, so
33
+ you can inspect exactly what runs on your network.
34
+
35
+ ## Licence
36
+
37
+ Released under the [Functional Source License, Version 1.1, ALv2 Future License](https://fsl.software/) (`FSL-1.1-ALv2`). The full text is in the LICENSE file.
38
+
39
+ ### Licence FAQ
40
+
41
+ This is a plain-language summary. The LICENSE file is the only binding text.
42
+
43
+ - **Can my company run it, including in CI, against our own systems?** Yes.
44
+ - **Can I modify it for my own use?** Yes. Copies you pass on must keep the LICENSE and copyright notices.
45
+ - **Can a consultant use it for a client?** Yes, as professional services for a client who has a licence to use it.
46
+ - **What is not allowed?** Making it available to others in a commercial product or service that substitutes for it, substitutes for a Locus product or service built on it, or offers the same or substantially similar functionality.
47
+ - **What happens later?** Each version becomes available under the Apache License 2.0 two years after it is released.
48
+
49
+ ### Trademarks
50
+
51
+ The licence covers the code only. It does not give any right to use the Locus name, logo or branding, or to suggest that your product is an official Locus service.