Skip to content

Commit 7255b40

Browse files
authored
Extract hls-test-utils (#1606)
* Extract hls-test-utils * Use test utils in brittany plugin and stylish haskell plugin * stack * Set locale encoding to utf8 in defaultMain * Remove with-utf8
1 parent 5724343 commit 7255b40

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+572
-441
lines changed

Diff for: .github/workflows/test.yml

+7
Original file line numberDiff line numberDiff line change
@@ -148,3 +148,10 @@ jobs:
148148
HLS_TEST_EXE: hls
149149
HLS_WRAPPER_TEST_EXE: hls-wrapper
150150
run: cabal test hls-stylish-haskell-plugin || cabal test hls-stylish-haskell-plugin --test-options="-j1"
151+
152+
- name: Test eval plugin
153+
if: ${{ matrix.test }}
154+
env:
155+
HLS_TEST_EXE: hls
156+
HLS_WRAPPER_TEST_EXE: hls-wrapper
157+
run: cabal test hls-eval-plugin || cabal test hls-eval-plugin --test-options="-j1"

Diff for: cabal.project

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ packages:
44
./shake-bench
55
./ghcide
66
./hls-plugin-api
7+
./hls-test-utils
78
./plugins/hls-tactics-plugin
89
./plugins/hls-brittany-plugin
910
./plugins/hls-stylish-haskell-plugin

Diff for: exe/Main.hs

+1-2
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,10 @@ module Main(main) where
66

77
import Ide.Arguments (Arguments (..), LspArguments (..), getArguments)
88
import Ide.Main (defaultMain)
9-
import Main.Utf8 (withUtf8)
109
import Plugins
1110

1211
main :: IO ()
13-
main = withUtf8 $ do
12+
main = do
1413
args <- getArguments "haskell-language-server"
1514

1615
let withExamples =

Diff for: ghcide/src/Development/IDE/Main.hs

+2
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ import Development.IDE.Types.Options (IdeGhcSession,
5353
defaultIdeOptions)
5454
import Development.IDE.Types.Shake (Key (Key))
5555
import Development.Shake (action)
56+
import GHC.IO.Encoding (setLocaleEncoding)
5657
import HIE.Bios.Cradle (findCradle)
5758
import Ide.Plugin.Config (CheckParents (NeverCheck),
5859
Config,
@@ -116,6 +117,7 @@ stderrLogger = do
116117

117118
defaultMain :: Arguments -> IO ()
118119
defaultMain Arguments{..} = do
120+
setLocaleEncoding utf8
119121
pid <- T.pack . show <$> getProcessID
120122
logger <- argsLogger
121123
hSetBuffering stderr LineBuffering

Diff for: haskell-language-server.cabal

+11-49
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,6 @@ executable haskell-language-server
327327
, temporary
328328
, transformers
329329
, unordered-containers
330-
, with-utf8
331330

332331
include-dirs: include
333332
default-language: Haskell2010
@@ -363,43 +362,9 @@ executable haskell-language-server-wrapper
363362

364363
default-language: Haskell2010
365364

366-
-- This common stanza simulates a previous private lib
367-
-- We removed it due to issues with stack when loading the project using a stack based hie.yaml
368-
-- See https://github.com/haskell/haskell-language-server/issues/114
369-
common hls-test-utils
370-
import: common-deps
371-
hs-source-dirs: test/utils
372-
other-modules: Test.Hls.Util
373-
build-depends:
374-
, aeson
375-
, blaze-markup
376-
, containers
377-
, data-default
378-
, lsp
379-
, hie-bios
380-
, hls-plugin-api >= 1.0 && < 1.2
381-
, hslogger
382-
, hspec
383-
, hspec-core
384-
, lens
385-
, lsp-test == 0.13.0.0
386-
, stm
387-
, tasty-expected-failure
388-
, tasty-hunit
389-
, temporary
390-
, transformers
391-
, unordered-containers
392-
, yaml
393-
394-
ghc-options: -Wall -Wredundant-constraints
395-
396-
if flag(pedantic)
397-
ghc-options: -Werror
398-
399-
default-language: Haskell2010
400365

401366
test-suite func-test
402-
import: common-deps, hls-test-utils
367+
import: common-deps
403368
type: exitcode-stdio-1.0
404369
default-language: Haskell2010
405370
build-tool-depends:
@@ -411,15 +376,16 @@ test-suite func-test
411376
, data-default
412377
, hspec-expectations
413378
, lens
414-
, tasty
415-
, tasty-ant-xml >=1.1.6
416-
, tasty-golden
417-
, tasty-rerun
418-
, megaparsec
419-
, deepseq
420379
, ghcide
380+
, hls-test-utils
381+
, lsp-types
382+
, aeson
383+
, hls-plugin-api >= 1.0 && < 1.2
384+
, lsp-test == 0.13.0.0
385+
, containers
386+
, unordered-containers
421387

422-
hs-source-dirs: test/functional plugins/hls-eval-plugin/test plugins/hls-splice-plugin/src plugins/hls-eval-plugin/src
388+
hs-source-dirs: test/functional plugins/hls-splice-plugin/src
423389

424390
main-is: Main.hs
425391
other-modules:
@@ -430,7 +396,6 @@ test-suite func-test
430396
Deferred
431397
Definition
432398
Diagnostic
433-
Eval
434399
Format
435400
FunctionalBadProject
436401
FunctionalCodeAction
@@ -446,7 +411,6 @@ test-suite func-test
446411
Splice
447412
HaddockComments
448413
Ide.Plugin.Splice.Types
449-
Ide.Plugin.Eval.Types
450414

451415
default-extensions: OverloadedStrings
452416
ghc-options:
@@ -456,7 +420,6 @@ test-suite func-test
456420
ghc-options: -Werror -Wredundant-constraints
457421

458422
test-suite wrapper-test
459-
import: hls-test-utils
460423
type: exitcode-stdio-1.0
461424
build-tool-depends:
462425
haskell-language-server:haskell-language-server-wrapper -any
@@ -466,9 +429,8 @@ test-suite wrapper-test
466429
, base
467430
, directory
468431
, process
469-
, tasty
470-
, tasty-ant-xml >=1.1.6
471-
, tasty-rerun
432+
, hls-test-utils
433+
, extra
472434

473435
hs-source-dirs: test/wrapper
474436
main-is: Main.hs

Diff for: hls-test-utils/LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

0 commit comments

Comments
 (0)