actions/compose-action
1
0
Fork 0
mirror of https://github.com/hoverkraft-tech/compose-action.git synced 2026-08-31 23:52:49 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

chore: use esbuild builder

Browse Source 
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
This commit is contained in:
Emilien Escalle 2026-08-05 15:27:45 +00:00
parent 616d330e4c
commit 20e118500b
31 changed files with 61902 additions and 88532 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
.devcontainer/devcontainer-lock.json Normal file
View File

@ -0,0 +1,24 @@
{
"features": {
"ghcr.io/devcontainers/features/common-utils:2": {
"version": "2.5.9",
"resolved": "ghcr.io/devcontainers/features/common-utils@sha256:cb0c4d3c276f157eed17935747e364178d75fee17f55c4e129966f64633deb3a",
"integrity": "sha256:cb0c4d3c276f157eed17935747e364178d75fee17f55c4e129966f64633deb3a"
},
"ghcr.io/devcontainers/features/docker-in-docker:4": {
"version": "4.0.0",
"resolved": "ghcr.io/devcontainers/features/docker-in-docker@sha256:4fa87399214366e320d489991769c4f3f461e1ffe461f54eea78a41b34945bb5",
"integrity": "sha256:4fa87399214366e320d489991769c4f3f461e1ffe461f54eea78a41b34945bb5"
},
"ghcr.io/devcontainers/features/github-cli:1": {
"version": "1.1.0",
"resolved": "ghcr.io/devcontainers/features/github-cli@sha256:d22f50b70ed75339b4eed1ba9ecde3a1791f90e88d37936517e3bace0bbad671",
"integrity": "sha256:d22f50b70ed75339b4eed1ba9ecde3a1791f90e88d37936517e3bace0bbad671"
},
"ghcr.io/devcontainers/features/node:2": {
"version": "2.1.0",
"resolved": "ghcr.io/devcontainers/features/node@sha256:586c9a6f7dd40bd3ba2cd41e7f2f88dcc31fbe5d1442afcbf07ffbc66b686857",
"integrity": "sha256:586c9a6f7dd40bd3ba2cd41e7f2f88dcc31fbe5d1442afcbf07ffbc66b686857"
}
}
}

58
.devcontainer/devcontainer.json
View File

@ -1,30 +1,32 @@
{ {
"name": "Debian", "name": "Debian",
"image": "mcr.microsoft.com/devcontainers/base:bullseye", "image": "mcr.microsoft.com/devcontainers/base:bullseye",
"features": { "features": {
"ghcr.io/devcontainers/features/node:2": {}, "ghcr.io/devcontainers/features/common-utils:2": {
"ghcr.io/devcontainers/features/docker-in-docker:": {}, "configureZshAsDefaultShell": true
"ghcr.io/devcontainers/features/github-cli:1": {} },
}, "ghcr.io/devcontainers/features/node:2": {},
"remoteEnv": { "ghcr.io/devcontainers/features/docker-in-docker:4": {
"GITHUB_TOKEN": "${localEnv:GITHUB_TOKEN}" "moby": false
}, },
"customizations": { "ghcr.io/devcontainers/features/github-cli:1": {}
"vscode": { },
"extensions": [ "remoteEnv": {
"eamodio.gitlens", "GITHUB_TOKEN": "${localEnv:GITHUB_TOKEN}"
"github.copilot", },
"github.copilot-chat", "customizations": {
"github.vscode-github-actions", "vscode": {
"ms-vscode.makefile-tools", "extensions": [
"bierner.markdown-preview-github-styles", "eamodio.gitlens",
"esbenp.prettier-vscode", "github.copilot",
"biomejs.biome", "github.copilot-chat",
"vitest.explorer" "github.vscode-github-actions",
], "ms-vscode.makefile-tools",
"settings": { "bierner.markdown-preview-github-styles",
"terminal.integrated.defaultProfile.linux": "zsh" "esbenp.prettier-vscode",
} "biomejs.biome",
} "vitest.explorer"
} ]
}
}
} }

2
.github/linters/.jscpd.json vendored
View File

@ -1,3 +1,3 @@
{ {
"ignore": ["**/dist/**", "**/node_modules/**", "**/coverage/**"] "ignore": ["**/dist/**", "**/node_modules/**", "**/coverage/**"]
} }

2
.github/workflows/main-ci.yml vendored
View File

@ -66,6 +66,8 @@ jobs:
with: with:
client-id: ${{ vars.CI_BOT_APP_CLIENT_ID }} client-id: ${{ vars.CI_BOT_APP_CLIENT_ID }}
private-key: ${{ secrets.CI_BOT_APP_PRIVATE_KEY }} # zizmor: ignore[secrets-outside-env] repository automation uses a dedicated app secret without untrusted code execution private-key: ${{ secrets.CI_BOT_APP_PRIVATE_KEY }} # zizmor: ignore[secrets-outside-env] repository automation uses a dedicated app secret without untrusted code execution
permission-contents: write
permission-pull-requests: write
- uses: hoverkraft-tech/ci-github-common/actions/create-and-merge-pull-request@2334d395217f9811699dbd4ace9d8559e4d99e0d # 0.37.3 - uses: hoverkraft-tech/ci-github-common/actions/create-and-merge-pull-request@2334d395217f9811699dbd4ace9d8559e4d99e0d # 0.37.3
with: with:

2
Dockerfile
View File

@ -1,4 +1,4 @@
FROM ghcr.io/hoverkraft-tech/docker-base-images/super-linter:0.6.0 FROM ghcr.io/hoverkraft-tech/docker-base-images/super-linter:0.4.1
HEALTHCHECK --interval=5m --timeout=10s --start-period=30s --retries=3 CMD ["/bin/sh","-c","test -d /github/home"] HEALTHCHECK --interval=5m --timeout=10s --start-period=30s --retries=3 CMD ["/bin/sh","-c","test -d /github/home"]
ARG UID=1000 ARG UID=1000
ARG GID=1000 ARG GID=1000

69
biome.json
View File

@ -1,34 +1,39 @@
{ {
"$schema": "https://biomejs.dev/schemas/2.4.16/schema.json", "$schema": "https://biomejs.dev/schemas/2.4.16/schema.json",
"vcs": { "vcs": {
"enabled": true, "enabled": true,
"clientKind": "git", "clientKind": "git",
"useIgnoreFile": true "useIgnoreFile": true
}, },
"files": { "files": {
"includes": ["**", "!!**/dist"] "includes": [
}, "**",
"formatter": { "!!**/dist",
"enabled": true, "!!.github/logo.svg",
"indentStyle": "tab" "!!.github/social-preview.svg"
}, ]
"linter": { },
"enabled": true, "formatter": {
"rules": { "enabled": true,
"recommended": true "indentStyle": "space"
} },
}, "linter": {
"javascript": { "enabled": true,
"formatter": { "rules": {
"quoteStyle": "double" "recommended": true
} }
}, },
"assist": { "javascript": {
"enabled": true, "formatter": {
"actions": { "quoteStyle": "double"
"source": { }
"organizeImports": "on" },
} "assist": {
} "enabled": true,
} "actions": {
"source": {
"organizeImports": "on"
}
}
}
} }

76820
dist/index.js generated vendored
View File

File diff suppressed because one or more lines are too long

634
dist/licenses.txt generated vendored
View File

@ -1,634 +0,0 @@
@actions/core
MIT
The MIT License (MIT)
Copyright 2019 GitHub
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@actions/exec
MIT
The MIT License (MIT)
Copyright 2019 GitHub
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@actions/github
MIT
The MIT License (MIT)
Copyright 2019 GitHub
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@actions/http-client
MIT
Actions Http Client for Node.js
Copyright (c) GitHub, Inc.
All rights reserved.
MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
associated documentation files (the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@actions/io
MIT
The MIT License (MIT)
Copyright 2019 GitHub
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@actions/tool-cache
MIT
The MIT License (MIT)
Copyright 2019 GitHub
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@octokit/auth-token
MIT
The MIT License
Copyright (c) 2019 Octokit contributors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
@octokit/core
MIT
The MIT License
Copyright (c) 2019 Octokit contributors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
@octokit/endpoint
MIT
The MIT License
Copyright (c) 2018 Octokit contributors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
@octokit/graphql
MIT
The MIT License
Copyright (c) 2018 Octokit contributors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
@octokit/plugin-paginate-rest
MIT
MIT License Copyright (c) 2019 Octokit contributors
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@octokit/plugin-rest-endpoint-methods
MIT
MIT License Copyright (c) 2019 Octokit contributors
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@octokit/request
MIT
The MIT License
Copyright (c) 2018 Octokit contributors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
@octokit/request-error
MIT
The MIT License
Copyright (c) 2019 Octokit contributors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
before-after-hook
Apache-2.0
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "{}"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2018 Gregor Martynus and other contributors.
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.
docker-compose
MIT
MIT License
Copyright (c) 2017 - 2021 PDMLab
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
fast-content-type-parse
MIT
MIT License
Copyright (c) 2023 The Fastify Team
The Fastify team members are listed at https://github.com/fastify/fastify#team
and in the README file.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
json-with-bigint
MIT
MIT License
Copyright (c) 2023 Ivan Korolenko
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
semver
ISC
The ISC License
Copyright (c) Isaac Z. Schlueter and Contributors
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
tunnel
MIT
The MIT License (MIT)
Copyright (c) 2012 Koichi Kobayashi
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
undici
MIT
MIT License
Copyright (c) Matteo Collina and Undici contributors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
universal-user-agent
ISC
# [ISC License](https://spdx.org/licenses/ISC)
Copyright (c) 2018-2021, Gregor Martynus (https://github.com/gr2m)
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
yaml
ISC
Copyright Eemeli Aro <eemeli@gmail.com>
Permission to use, copy, modify, and/or distribute this software for any purpose
with or without fee is hereby granted, provided that the above copyright notice
and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
THIS SOFTWARE.

3
dist/package.json generated vendored
View File

@ -1,3 +0,0 @@
{
"type": "module"
}

66602
dist/post.js generated vendored
View File

File diff suppressed because one or more lines are too long

1946
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

125
package.json
View File

@ -1,64 +1,65 @@
{ {
"name": "compose-action", "name": "compose-action",
"description": "Docker Compose Action", "description": "Docker Compose Action",
"version": "0.0.0", "version": "0.0.0",
"author": "hoverkraft", "author": "hoverkraft",
"license": "MIT", "license": "MIT",
"homepage": "https://github.com/hoverkraft-tech/compose-action", "homepage": "https://github.com/hoverkraft-tech/compose-action",
"private": true, "private": true,
"type": "module", "type": "module",
"repository": { "repository": {
"type": "git", "type": "git",
"url": "git+https://github.com/hoverkraft-tech/compose-action.git" "url": "git+https://github.com/hoverkraft-tech/compose-action.git"
}, },
"bugs": { "bugs": {
"url": "https://github.com/hoverkraft-tech/compose-action/issues" "url": "https://github.com/hoverkraft-tech/compose-action/issues"
}, },
"keywords": [ "keywords": [
"actions", "actions",
"docker-compose" "docker-compose"
], ],
"exports": { "exports": {
".": "./dist/index.js" ".": "./dist/index.js"
}, },
"engines": { "engines": {
"node": ">=24" "node": ">=24"
}, },
"dependencies": { "dependencies": {
"@actions/core": "^3.0.1", "@actions/core": "^3.0.1",
"@actions/github": "^9.1.1", "@actions/github": "^9.1.1",
"@actions/tool-cache": "^4.0.0", "@actions/tool-cache": "^4.0.0",
"@octokit/action": "^8.0.4", "@octokit/action": "^8.0.4",
"docker-compose": "^1.4.2" "docker-compose": "^1.4.2"
}, },
"devDependencies": { "devDependencies": {
"@ts-dev-tools/core": "^1.12.4", "@ts-dev-tools/core": "^1.13.1",
"@vercel/ncc": "^0.44.0" "esbuild": "^0.27.0"
}, },
"scripts": { "scripts": {
"package": "npm run package:index && npm run package:post", "package": "rm -rf dist && esbuild src/index.ts src/post.ts --bundle --format=esm --platform=node --target=node24 --outdir=dist --entry-names=[name]",
"package:index": "ncc build src/index.ts -o dist --license licenses.txt", "package:watch": "esbuild src/index.ts src/post.ts --bundle --format=esm --platform=node --target=node24 --outdir=dist --entry-names=[name] --watch",
"package:post": "ncc build src/post.ts -o dist/post && mv dist/post/index.js dist/post.js && rm -rf dist/post", "lint": "biome lint --error-on-warnings .",
"package:watch": "npm run package -- --watch", "lint:ci": "biome lint --error-on-warnings . --reporter=sarif | tee biome-report.sarif",
"lint": "biome lint --error-on-warnings .", "all": "npm run format && npm run lint:ci && npm run test:ci && npm run package",
"lint:ci": "biome lint --error-on-warnings . --reporter=sarif | tee biome-report.sarif", "build": "tsc --noEmit",
"all": "npm run format && npm run lint:ci && npm run test:ci && npm run package", "format": "biome format --write .",
"build": "tsc --noEmit", "test": "vitest run",
"format": "biome format --write .", "test:watch": "vitest",
"test": "vitest run", "test:cov": "vitest run --reporter=default --reporter=junit --outputFile=junit.xml --coverage.enabled --coverage.reporter=lcov --coverage.reporter=text",
"test:watch": "vitest", "test:ci": "npm run test:cov",
"test:cov": "vitest run --reporter=default --reporter=junit --outputFile=junit.xml --coverage.enabled --coverage.reporter=lcov --coverage.reporter=text", "prepare": "ts-dev-tools install",
"test:ci": "npm run test:cov", "check": "biome check --error-on-warnings --write .",
"prepare": "ts-dev-tools install", "vitest": "vitest"
"check": "biome check --error-on-warnings --write .", },
"vitest": "vitest" "commitlint": {
}, "extends": [
"commitlint": { "@commitlint/config-conventional"
"extends": [ ]
"@commitlint/config-conventional" },
] "tsDevTools": {
}, "version": "20260604100000-migrate-to-vitest"
"tsDevTools": { },
"version": "20260604100000-migrate-to-vitest" "allowScripts": {
} "esbuild@0.27.7": true
}
} }

308
src/index-runner.test.ts
View File

@ -1,204 +1,204 @@
import { describe, expect, it, beforeEach, vi } from "vitest"; import { beforeEach, describe, expect, it, vi } from "vitest";
// Mock @actions/core // Mock @actions/core
const setFailedMock = vi.fn(); const setFailedMock = vi.fn();
vi.doMock("@actions/core", () => ({ vi.doMock("@actions/core", () => ({
setFailed: setFailedMock, setFailed: setFailedMock,
getInput: vi.fn().mockReturnValue(""), getInput: vi.fn().mockReturnValue(""),
getMultilineInput: vi.fn().mockReturnValue([]), getMultilineInput: vi.fn().mockReturnValue([]),
debug: vi.fn(), debug: vi.fn(),
info: vi.fn(), info: vi.fn(),
warning: vi.fn(), warning: vi.fn(),
})); }));
// Mock docker-compose // Mock docker-compose
vi.doMock("docker-compose", () => ({ vi.doMock("docker-compose", () => ({
upAll: vi.fn(), upAll: vi.fn(),
upMany: vi.fn(), upMany: vi.fn(),
down: vi.fn(), down: vi.fn(),
logs: vi.fn(), logs: vi.fn(),
version: vi version: vi
.fn<() => Promise<{ data: { version: string } }>>() .fn<() => Promise<{ data: { version: string } }>>()
.mockResolvedValue({ data: { version: "1.2.3" } }), .mockResolvedValue({ data: { version: "1.2.3" } }),
})); }));
// Mock node:fs // Mock node:fs
vi.doMock("node:fs", async () => { vi.doMock("node:fs", async () => {
const actualFs = await vi.importActual<typeof import("node:fs")>("node:fs"); const actualFs = await vi.importActual<typeof import("node:fs")>("node:fs");
return { return {
...actualFs, ...actualFs,
existsSync: vi.fn().mockReturnValue(true), existsSync: vi.fn().mockReturnValue(true),
default: { default: {
...actualFs, ...actualFs,
existsSync: vi.fn().mockReturnValue(true), existsSync: vi.fn().mockReturnValue(true),
}, },
}; };
}); });
// Dynamic imports after mock setup // Dynamic imports after mock setup
const { run } = await import("./index-runner.js"); const { run } = await import("./index-runner.js");
const { InputService } = await import("./services/input.service.js"); const { InputService } = await import("./services/input.service.js");
const { LoggerService, LogLevel } = await import( const { LoggerService, LogLevel } = await import(
"./services/logger.service.js" "./services/logger.service.js"
); );
const { DockerComposeInstallerService } = await import( const { DockerComposeInstallerService } = await import(
"./services/docker-compose-installer.service.js" "./services/docker-compose-installer.service.js"
); );
const { DockerComposeService } = await import( const { DockerComposeService } = await import(
"./services/docker-compose.service.js" "./services/docker-compose.service.js"
); );
describe("run", () => { describe("run", () => {
let infoMock: ReturnType<typeof vi.spyOn>; let infoMock: ReturnType<typeof vi.spyOn>;
let debugMock: ReturnType<typeof vi.spyOn>; let debugMock: ReturnType<typeof vi.spyOn>;
let getInputsMock: ReturnType<typeof vi.spyOn>; let getInputsMock: ReturnType<typeof vi.spyOn>;
let installMock: ReturnType<typeof vi.spyOn>; let installMock: ReturnType<typeof vi.spyOn>;
let upMock: ReturnType<typeof vi.spyOn>; let upMock: ReturnType<typeof vi.spyOn>;
beforeEach(() => { beforeEach(() => {
vi.clearAllMocks(); vi.clearAllMocks();
infoMock = vi infoMock = vi
.spyOn(LoggerService.prototype, "info") .spyOn(LoggerService.prototype, "info")
.mockImplementation(() => {}); .mockImplementation(() => {});
debugMock = vi debugMock = vi
.spyOn(LoggerService.prototype, "debug") .spyOn(LoggerService.prototype, "debug")
.mockImplementation(() => {}); .mockImplementation(() => {});
getInputsMock = vi.spyOn(InputService.prototype, "getInputs"); getInputsMock = vi.spyOn(InputService.prototype, "getInputs");
installMock = vi.spyOn(DockerComposeInstallerService.prototype, "install"); installMock = vi.spyOn(DockerComposeInstallerService.prototype, "install");
upMock = vi.spyOn(DockerComposeService.prototype, "up"); upMock = vi.spyOn(DockerComposeService.prototype, "up");
}); });
it("should install docker compose with specified version", async () => { it("should install docker compose with specified version", async () => {
// Arrange // Arrange
getInputsMock.mockImplementation(() => ({ getInputsMock.mockImplementation(() => ({
dockerFlags: [], dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: [], services: [],
composeFlags: [], composeFlags: [],
upFlags: [], upFlags: [],
downFlags: [], downFlags: [],
cwd: "/current/working/dir", cwd: "/current/working/dir",
composeVersion: "1.29.2", composeVersion: "1.29.2",
githubToken: null, githubToken: null,
serviceLogLevel: LogLevel.Debug, serviceLogLevel: LogLevel.Debug,
})); }));
installMock.mockResolvedValue("1.29.2"); installMock.mockResolvedValue("1.29.2");
upMock.mockResolvedValue(); upMock.mockResolvedValue();
// Act // Act
await run(); await run();
// Assert // Assert
expect(infoMock).toHaveBeenCalledWith( expect(infoMock).toHaveBeenCalledWith(
"Setting up docker compose version 1.29.2", "Setting up docker compose version 1.29.2",
); );
expect(debugMock).toHaveBeenCalledWith( expect(debugMock).toHaveBeenCalledWith(
'inputs: {"dockerFlags":[],"composeFiles":["docker-compose.yml"],"services":[],"composeFlags":[],"upFlags":[],"downFlags":[],"cwd":"/current/working/dir","composeVersion":"1.29.2","githubToken":null,"serviceLogLevel":"debug"}', 'inputs: {"dockerFlags":[],"composeFiles":["docker-compose.yml"],"services":[],"composeFlags":[],"upFlags":[],"downFlags":[],"cwd":"/current/working/dir","composeVersion":"1.29.2","githubToken":null,"serviceLogLevel":"debug"}',
); );
expect(installMock).toHaveBeenCalledWith({ expect(installMock).toHaveBeenCalledWith({
composeVersion: "1.29.2", composeVersion: "1.29.2",
cwd: "/current/working/dir", cwd: "/current/working/dir",
githubToken: null, githubToken: null,
}); });
expect(upMock).toHaveBeenCalledWith({ expect(upMock).toHaveBeenCalledWith({
dockerFlags: [], dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
composeFlags: [], composeFlags: [],
cwd: "/current/working/dir", cwd: "/current/working/dir",
upFlags: [], upFlags: [],
services: [], services: [],
serviceLogger: debugMock, serviceLogger: debugMock,
}); });
expect(setFailedMock).not.toHaveBeenCalled(); expect(setFailedMock).not.toHaveBeenCalled();
}); });
it("should bring up docker compose services", async () => { it("should bring up docker compose services", async () => {
// Arrange // Arrange
getInputsMock.mockImplementation(() => ({ getInputsMock.mockImplementation(() => ({
dockerFlags: [], dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: ["web"], services: ["web"],
composeFlags: [], composeFlags: [],
upFlags: [], upFlags: [],
downFlags: [], downFlags: [],
cwd: "/current/working/dir", cwd: "/current/working/dir",
composeVersion: null, composeVersion: null,
githubToken: null, githubToken: null,
serviceLogLevel: LogLevel.Debug, serviceLogLevel: LogLevel.Debug,
})); }));
// Act // Act
await run(); await run();
// Assert // Assert
expect(upMock).toHaveBeenCalledWith({ expect(upMock).toHaveBeenCalledWith({
dockerFlags: [], dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
composeFlags: [], composeFlags: [],
cwd: "/current/working/dir", cwd: "/current/working/dir",
upFlags: [], upFlags: [],
services: ["web"], services: ["web"],
serviceLogger: debugMock, serviceLogger: debugMock,
}); });
expect(setFailedMock).not.toHaveBeenCalled(); expect(setFailedMock).not.toHaveBeenCalled();
}); });
it("should handle errors and call setFailed", async () => { it("should handle errors and call setFailed", async () => {
// Arrange // Arrange
const error = new Error("Test error"); const error = new Error("Test error");
upMock.mockRejectedValue(error); upMock.mockRejectedValue(error);
getInputsMock.mockImplementation(() => ({ getInputsMock.mockImplementation(() => ({
dockerFlags: [], dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: ["web"], services: ["web"],
composeFlags: [], composeFlags: [],
upFlags: [], upFlags: [],
downFlags: [], downFlags: [],
cwd: "/current/working/dir", cwd: "/current/working/dir",
composeVersion: null, composeVersion: null,
githubToken: null, githubToken: null,
serviceLogLevel: LogLevel.Debug, serviceLogLevel: LogLevel.Debug,
})); }));
// Act // Act
await run(); await run();
// Assert // Assert
expect(setFailedMock).toHaveBeenCalledWith("Error: Test error"); expect(setFailedMock).toHaveBeenCalledWith("Error: Test error");
}); });
it("should handle unknown errors and call setFailed", async () => { it("should handle unknown errors and call setFailed", async () => {
// Arrange // Arrange
const error = "Test error"; const error = "Test error";
upMock.mockRejectedValue(error); upMock.mockRejectedValue(error);
getInputsMock.mockImplementation(() => ({ getInputsMock.mockImplementation(() => ({
dockerFlags: [], dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: ["web"], services: ["web"],
composeFlags: [], composeFlags: [],
upFlags: [], upFlags: [],
downFlags: [], downFlags: [],
cwd: "/current/working/dir", cwd: "/current/working/dir",
composeVersion: null, composeVersion: null,
githubToken: null, githubToken: null,
serviceLogLevel: LogLevel.Debug, serviceLogLevel: LogLevel.Debug,
})); }));
// Act // Act
await run(); await run();
// Assert // Assert
expect(setFailedMock).toHaveBeenCalledWith('"Test error"'); expect(setFailedMock).toHaveBeenCalledWith('"Test error"');
}); });
}); });

70
src/index-runner.ts
View File

@ -1,51 +1,51 @@
import { setFailed } from "@actions/core"; import { setFailed } from "@actions/core";
import { InputService } from "./services/input.service.js";
import { LoggerService } from "./services/logger.service.js";
import { DockerComposeService } from "./services/docker-compose.service.js"; import { DockerComposeService } from "./services/docker-compose.service.js";
import { DockerComposeInstallerService } from "./services/docker-compose-installer.service.js"; import { DockerComposeInstallerService } from "./services/docker-compose-installer.service.js";
import { InputService } from "./services/input.service.js";
import { ManualInstallerAdapter } from "./services/installer-adapter/manual-installer-adapter.js"; import { ManualInstallerAdapter } from "./services/installer-adapter/manual-installer-adapter.js";
import { LoggerService } from "./services/logger.service.js";
/** /**
* The run function for the action. * The run function for the action.
* @returns {Promise<void>} Resolves when the action is complete. * @returns {Promise<void>} Resolves when the action is complete.
*/ */
export async function run(): Promise<void> { export async function run(): Promise<void> {
try { try {
const loggerService = new LoggerService(); const loggerService = new LoggerService();
const inputService = new InputService(); const inputService = new InputService();
const dockerComposeInstallerService = new DockerComposeInstallerService( const dockerComposeInstallerService = new DockerComposeInstallerService(
new ManualInstallerAdapter(), new ManualInstallerAdapter(),
); );
const dockerComposeService = new DockerComposeService(); const dockerComposeService = new DockerComposeService();
const inputs = inputService.getInputs(); const inputs = inputService.getInputs();
loggerService.debug(`inputs: ${JSON.stringify(inputs)}`); loggerService.debug(`inputs: ${JSON.stringify(inputs)}`);
loggerService.info( loggerService.info(
"Setting up docker compose" + "Setting up docker compose" +
(inputs.composeVersion ? ` version ${inputs.composeVersion}` : ""), (inputs.composeVersion ? ` version ${inputs.composeVersion}` : ""),
); );
const installedVersion = await dockerComposeInstallerService.install({ const installedVersion = await dockerComposeInstallerService.install({
composeVersion: inputs.composeVersion, composeVersion: inputs.composeVersion,
cwd: inputs.cwd, cwd: inputs.cwd,
githubToken: inputs.githubToken, githubToken: inputs.githubToken,
}); });
loggerService.info(`docker compose version: ${installedVersion}`); loggerService.info(`docker compose version: ${installedVersion}`);
loggerService.info("Bringing up docker compose service(s)"); loggerService.info("Bringing up docker compose service(s)");
await dockerComposeService.up({ await dockerComposeService.up({
dockerFlags: inputs.dockerFlags, dockerFlags: inputs.dockerFlags,
composeFiles: inputs.composeFiles, composeFiles: inputs.composeFiles,
composeFlags: inputs.composeFlags, composeFlags: inputs.composeFlags,
cwd: inputs.cwd, cwd: inputs.cwd,
upFlags: inputs.upFlags, upFlags: inputs.upFlags,
services: inputs.services, services: inputs.services,
serviceLogger: loggerService.getServiceLogger(inputs.serviceLogLevel), serviceLogger: loggerService.getServiceLogger(inputs.serviceLogLevel),
}); });
loggerService.info("docker compose service(s) are up"); loggerService.info("docker compose service(s) are up");
} catch (error) { } catch (error) {
setFailed(`${error instanceof Error ? error : JSON.stringify(error)}`); setFailed(`${error instanceof Error ? error : JSON.stringify(error)}`);
} }
} }

168
src/index.test.ts
View File

@ -1,52 +1,52 @@
import { describe, expect, it, beforeEach, vi } from "vitest"; import { beforeEach, describe, expect, it, vi } from "vitest";
// Mock @actions/core // Mock @actions/core
const setFailedMock = vi.fn(); const setFailedMock = vi.fn();
vi.doMock("@actions/core", () => ({ vi.doMock("@actions/core", () => ({
setFailed: setFailedMock, setFailed: setFailedMock,
getInput: vi.fn().mockReturnValue(""), getInput: vi.fn().mockReturnValue(""),
getMultilineInput: vi.fn().mockReturnValue([]), getMultilineInput: vi.fn().mockReturnValue([]),
debug: vi.fn(), debug: vi.fn(),
info: vi.fn(), info: vi.fn(),
warning: vi.fn(), warning: vi.fn(),
})); }));
// Mock docker-compose // Mock docker-compose
vi.doMock("docker-compose", () => ({ vi.doMock("docker-compose", () => ({
upAll: vi.fn(), upAll: vi.fn(),
upMany: vi.fn(), upMany: vi.fn(),
down: vi.fn(), down: vi.fn(),
logs: vi.fn(), logs: vi.fn(),
version: vi version: vi
.fn<() => Promise<{ data: { version: string } }>>() .fn<() => Promise<{ data: { version: string } }>>()
.mockResolvedValue({ data: { version: "1.2.3" } }), .mockResolvedValue({ data: { version: "1.2.3" } }),
})); }));
// Mock node:fs // Mock node:fs
vi.doMock("node:fs", async () => { vi.doMock("node:fs", async () => {
const actualFs = await vi.importActual<typeof import("node:fs")>("node:fs"); const actualFs = await vi.importActual<typeof import("node:fs")>("node:fs");
return { return {
...actualFs, ...actualFs,
existsSync: vi.fn().mockReturnValue(true), existsSync: vi.fn().mockReturnValue(true),
default: { default: {
...actualFs, ...actualFs,
existsSync: vi.fn().mockReturnValue(true), existsSync: vi.fn().mockReturnValue(true),
}, },
}; };
}); });
// Dynamic imports after mock setup // Dynamic imports after mock setup
const { InputService } = await import("./services/input.service.js"); const { InputService } = await import("./services/input.service.js");
const { LoggerService, LogLevel } = await import( const { LoggerService, LogLevel } = await import(
"./services/logger.service.js" "./services/logger.service.js"
); );
const { DockerComposeInstallerService } = await import( const { DockerComposeInstallerService } = await import(
"./services/docker-compose-installer.service.js" "./services/docker-compose-installer.service.js"
); );
const { DockerComposeService } = await import( const { DockerComposeService } = await import(
"./services/docker-compose.service.js" "./services/docker-compose.service.js"
); );
let getInputsMock: ReturnType<typeof vi.spyOn>; let getInputsMock: ReturnType<typeof vi.spyOn>;
@ -56,72 +56,72 @@ let installMock: ReturnType<typeof vi.spyOn>;
let upMock: ReturnType<typeof vi.spyOn>; let upMock: ReturnType<typeof vi.spyOn>;
describe("index", () => { describe("index", () => {
beforeEach(() => { beforeEach(() => {
vi.clearAllMocks(); vi.clearAllMocks();
infoMock = vi infoMock = vi
.spyOn(LoggerService.prototype, "info") .spyOn(LoggerService.prototype, "info")
.mockImplementation(() => {}); .mockImplementation(() => {});
debugMock = vi debugMock = vi
.spyOn(LoggerService.prototype, "debug") .spyOn(LoggerService.prototype, "debug")
.mockImplementation(() => {}); .mockImplementation(() => {});
getInputsMock = vi.spyOn(InputService.prototype, "getInputs"); getInputsMock = vi.spyOn(InputService.prototype, "getInputs");
installMock = vi.spyOn(DockerComposeInstallerService.prototype, "install"); installMock = vi.spyOn(DockerComposeInstallerService.prototype, "install");
upMock = vi.spyOn(DockerComposeService.prototype, "up"); upMock = vi.spyOn(DockerComposeService.prototype, "up");
}); });
it("calls run when imported", async () => { it("calls run when imported", async () => {
getInputsMock.mockImplementation(() => ({ getInputsMock.mockImplementation(() => ({
dockerFlags: [], dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: [], services: [],
composeFlags: [], composeFlags: [],
upFlags: [], upFlags: [],
downFlags: [], downFlags: [],
cwd: "/current/working/dir", cwd: "/current/working/dir",
composeVersion: null, composeVersion: null,
githubToken: null, githubToken: null,
serviceLogLevel: LogLevel.Debug, serviceLogLevel: LogLevel.Debug,
})); }));
installMock.mockResolvedValue("1.2.3"); installMock.mockResolvedValue("1.2.3");
upMock.mockResolvedValueOnce(); upMock.mockResolvedValueOnce();
await import("./index.js"); await import("./index.js");
await new Promise((resolve) => setTimeout(resolve, 0)); await new Promise((resolve) => setTimeout(resolve, 0));
expect(infoMock).toHaveBeenNthCalledWith(1, "Setting up docker compose"); expect(infoMock).toHaveBeenNthCalledWith(1, "Setting up docker compose");
expect(infoMock).toHaveBeenNthCalledWith( expect(infoMock).toHaveBeenNthCalledWith(
2, 2,
"docker compose version: 1.2.3", "docker compose version: 1.2.3",
); );
// Verify that all of the functions were called correctly // Verify that all of the functions were called correctly
expect(debugMock).toHaveBeenNthCalledWith( expect(debugMock).toHaveBeenNthCalledWith(
1, 1,
'inputs: {"dockerFlags":[],"composeFiles":["docker-compose.yml"],"services":[],"composeFlags":[],"upFlags":[],"downFlags":[],"cwd":"/current/working/dir","composeVersion":null,"githubToken":null,"serviceLogLevel":"debug"}', 'inputs: {"dockerFlags":[],"composeFiles":["docker-compose.yml"],"services":[],"composeFlags":[],"upFlags":[],"downFlags":[],"cwd":"/current/working/dir","composeVersion":null,"githubToken":null,"serviceLogLevel":"debug"}',
); );
expect(infoMock).toHaveBeenNthCalledWith( expect(infoMock).toHaveBeenNthCalledWith(
3, 3,
"Bringing up docker compose service(s)", "Bringing up docker compose service(s)",
); );
expect(upMock).toHaveBeenCalledWith({ expect(upMock).toHaveBeenCalledWith({
dockerFlags: [], dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: [], services: [],
composeFlags: [], composeFlags: [],
upFlags: [], upFlags: [],
cwd: "/current/working/dir", cwd: "/current/working/dir",
serviceLogger: debugMock, serviceLogger: debugMock,
}); });
expect(setFailedMock).not.toHaveBeenCalled(); expect(setFailedMock).not.toHaveBeenCalled();
expect(infoMock).toHaveBeenNthCalledWith( expect(infoMock).toHaveBeenNthCalledWith(
4, 4,
"docker compose service(s) are up", "docker compose service(s) are up",
); );
}); });
}); });

306
src/post-runner.test.ts
View File

@ -1,15 +1,15 @@
import { describe, expect, it, beforeEach, vi } from "vitest"; import { beforeEach, describe, expect, it, vi } from "vitest";
// Mock @actions/core // Mock @actions/core
const setFailedMock = vi.fn(); const setFailedMock = vi.fn();
vi.doMock("@actions/core", () => ({ vi.doMock("@actions/core", () => ({
setFailed: setFailedMock, setFailed: setFailedMock,
getInput: vi.fn().mockReturnValue(""), getInput: vi.fn().mockReturnValue(""),
getMultilineInput: vi.fn().mockReturnValue([]), getMultilineInput: vi.fn().mockReturnValue([]),
debug: vi.fn(), debug: vi.fn(),
info: vi.fn(), info: vi.fn(),
warning: vi.fn(), warning: vi.fn(),
})); }));
// Mock docker-compose // Mock docker-compose
@ -17,189 +17,189 @@ const logsMock = vi.fn();
const downMock = vi.fn(); const downMock = vi.fn();
vi.doMock("docker-compose", () => ({ vi.doMock("docker-compose", () => ({
logs: logsMock, logs: logsMock,
down: downMock, down: downMock,
upAll: vi.fn(), upAll: vi.fn(),
upMany: vi.fn(), upMany: vi.fn(),
})); }));
// Mock node:fs // Mock node:fs
vi.doMock("node:fs", () => ({ vi.doMock("node:fs", () => ({
existsSync: vi.fn().mockReturnValue(true), existsSync: vi.fn().mockReturnValue(true),
default: { existsSync: vi.fn().mockReturnValue(true) }, default: { existsSync: vi.fn().mockReturnValue(true) },
})); }));
// Dynamic imports after mock setup // Dynamic imports after mock setup
const { run } = await import("./post-runner.js"); const { run } = await import("./post-runner.js");
const { InputService } = await import("./services/input.service.js"); const { InputService } = await import("./services/input.service.js");
const { LoggerService, LogLevel } = await import( const { LoggerService, LogLevel } = await import(
"./services/logger.service.js" "./services/logger.service.js"
); );
const { DockerComposeService } = await import( const { DockerComposeService } = await import(
"./services/docker-compose.service.js" "./services/docker-compose.service.js"
); );
describe("run", () => { describe("run", () => {
let infoMock: ReturnType<typeof vi.spyOn>; let infoMock: ReturnType<typeof vi.spyOn>;
let debugMock: ReturnType<typeof vi.spyOn>; let debugMock: ReturnType<typeof vi.spyOn>;
let getInputsMock: ReturnType<typeof vi.spyOn>; let getInputsMock: ReturnType<typeof vi.spyOn>;
let serviceDownMock: ReturnType<typeof vi.spyOn>; let serviceDownMock: ReturnType<typeof vi.spyOn>;
let serviceLogsMock: ReturnType<typeof vi.spyOn>; let serviceLogsMock: ReturnType<typeof vi.spyOn>;
beforeEach(() => { beforeEach(() => {
vi.clearAllMocks(); vi.clearAllMocks();
infoMock = vi infoMock = vi
.spyOn(LoggerService.prototype, "info") .spyOn(LoggerService.prototype, "info")
.mockImplementation(() => {}); .mockImplementation(() => {});
debugMock = vi debugMock = vi
.spyOn(LoggerService.prototype, "debug") .spyOn(LoggerService.prototype, "debug")
.mockImplementation(() => {}); .mockImplementation(() => {});
getInputsMock = vi.spyOn(InputService.prototype, "getInputs"); getInputsMock = vi.spyOn(InputService.prototype, "getInputs");
serviceDownMock = vi.spyOn(DockerComposeService.prototype, "down"); serviceDownMock = vi.spyOn(DockerComposeService.prototype, "down");
serviceLogsMock = vi.spyOn(DockerComposeService.prototype, "logs"); serviceLogsMock = vi.spyOn(DockerComposeService.prototype, "logs");
}); });
it("should bring down docker compose service(s) and log output", async () => { it("should bring down docker compose service(s) and log output", async () => {
// Arrange // Arrange
getInputsMock.mockImplementation(() => ({ getInputsMock.mockImplementation(() => ({
dockerFlags: [], dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: [], services: [],
composeFlags: [], composeFlags: [],
upFlags: [], upFlags: [],
downFlags: [], downFlags: [],
cwd: "/current/working/dir", cwd: "/current/working/dir",
composeVersion: null, composeVersion: null,
githubToken: null, githubToken: null,
serviceLogLevel: LogLevel.Debug, serviceLogLevel: LogLevel.Debug,
})); }));
serviceLogsMock.mockResolvedValue({ error: "", output: "test logs" }); serviceLogsMock.mockResolvedValue({ error: "", output: "test logs" });
serviceDownMock.mockResolvedValue(); serviceDownMock.mockResolvedValue();
// Act // Act
await run(); await run();
// Assert // Assert
expect(serviceLogsMock).toHaveBeenCalledWith({ expect(serviceLogsMock).toHaveBeenCalledWith({
dockerFlags: [], dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
composeFlags: [], composeFlags: [],
cwd: "/current/working/dir", cwd: "/current/working/dir",
services: [], services: [],
serviceLogger: debugMock, serviceLogger: debugMock,
}); });
expect(serviceDownMock).toHaveBeenCalledWith({ expect(serviceDownMock).toHaveBeenCalledWith({
dockerFlags: [], dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
composeFlags: [], composeFlags: [],
cwd: "/current/working/dir", cwd: "/current/working/dir",
downFlags: [], downFlags: [],
serviceLogger: debugMock, serviceLogger: debugMock,
}); });
expect(debugMock).toHaveBeenCalledWith("docker compose logs:\ntest logs"); expect(debugMock).toHaveBeenCalledWith("docker compose logs:\ntest logs");
expect(infoMock).toHaveBeenCalledWith("docker compose is down"); expect(infoMock).toHaveBeenCalledWith("docker compose is down");
expect(setFailedMock).not.toHaveBeenCalled(); expect(setFailedMock).not.toHaveBeenCalled();
}); });
it("should log docker composer errors if any", async () => { it("should log docker composer errors if any", async () => {
// Arrange // Arrange
getInputsMock.mockImplementation(() => ({ getInputsMock.mockImplementation(() => ({
dockerFlags: [], dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: [], services: [],
composeFlags: [], composeFlags: [],
upFlags: [], upFlags: [],
downFlags: [], downFlags: [],
cwd: "/current/working/dir", cwd: "/current/working/dir",
composeVersion: null, composeVersion: null,
githubToken: null, githubToken: null,
serviceLogLevel: LogLevel.Debug, serviceLogLevel: LogLevel.Debug,
})); }));
serviceLogsMock.mockResolvedValue({ serviceLogsMock.mockResolvedValue({
error: "test logs error", error: "test logs error",
output: "test logs output", output: "test logs output",
}); });
serviceDownMock.mockResolvedValue(); serviceDownMock.mockResolvedValue();
// Act // Act
await run(); await run();
// Assert // Assert
expect(debugMock).toHaveBeenCalledWith( expect(debugMock).toHaveBeenCalledWith(
"docker compose error:\ntest logs error", "docker compose error:\ntest logs error",
); );
expect(debugMock).toHaveBeenCalledWith( expect(debugMock).toHaveBeenCalledWith(
"docker compose logs:\ntest logs output", "docker compose logs:\ntest logs output",
); );
expect(infoMock).toHaveBeenCalledWith("docker compose is down"); expect(infoMock).toHaveBeenCalledWith("docker compose is down");
}); });
it("should set failed when an error occurs", async () => { it("should set failed when an error occurs", async () => {
// Arrange // Arrange
getInputsMock.mockImplementation(() => { getInputsMock.mockImplementation(() => {
throw new Error("An error occurred"); throw new Error("An error occurred");
}); });
// Act // Act
await run(); await run();
// Assert // Assert
expect(setFailedMock).toHaveBeenCalledWith("Error: An error occurred"); expect(setFailedMock).toHaveBeenCalledWith("Error: An error occurred");
}); });
it("should handle errors and call setFailed", async () => { it("should handle errors and call setFailed", async () => {
// Arrange // Arrange
const error = new Error("Test error"); const error = new Error("Test error");
serviceDownMock.mockRejectedValue(error); serviceDownMock.mockRejectedValue(error);
getInputsMock.mockImplementation(() => ({ getInputsMock.mockImplementation(() => ({
dockerFlags: [], dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: ["web"], services: ["web"],
composeFlags: [], composeFlags: [],
upFlags: [], upFlags: [],
downFlags: [], downFlags: [],
cwd: "/current/working/dir", cwd: "/current/working/dir",
composeVersion: null, composeVersion: null,
githubToken: null, githubToken: null,
serviceLogLevel: LogLevel.Debug, serviceLogLevel: LogLevel.Debug,
})); }));
// Act // Act
await run(); await run();
// Assert // Assert
expect(setFailedMock).toHaveBeenCalledWith("Error: Test error"); expect(setFailedMock).toHaveBeenCalledWith("Error: Test error");
}); });
it("should handle unknown errors and call setFailed", async () => { it("should handle unknown errors and call setFailed", async () => {
// Arrange // Arrange
const error = "Test error"; const error = "Test error";
serviceDownMock.mockRejectedValue(error); serviceDownMock.mockRejectedValue(error);
getInputsMock.mockImplementation(() => ({ getInputsMock.mockImplementation(() => ({
dockerFlags: [], dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: ["web"], services: ["web"],
composeFlags: [], composeFlags: [],
upFlags: [], upFlags: [],
downFlags: [], downFlags: [],
cwd: "/current/working/dir", cwd: "/current/working/dir",
composeVersion: null, composeVersion: null,
githubToken: null, githubToken: null,
serviceLogLevel: LogLevel.Debug, serviceLogLevel: LogLevel.Debug,
})); }));
// Act // Act
await run(); await run();
// Assert // Assert
expect(setFailedMock).toHaveBeenCalledWith('"Test error"'); expect(setFailedMock).toHaveBeenCalledWith('"Test error"');
}); });
}); });

60
src/post-runner.ts
View File

@ -1,46 +1,46 @@
import { setFailed } from "@actions/core"; import { setFailed } from "@actions/core";
import { DockerComposeService } from "./services/docker-compose.service.js";
import { InputService } from "./services/input.service.js"; import { InputService } from "./services/input.service.js";
import { LoggerService } from "./services/logger.service.js"; import { LoggerService } from "./services/logger.service.js";
import { DockerComposeService } from "./services/docker-compose.service.js";
/** /**
* The run function for the action. * The run function for the action.
* @returns {Promise<void>} Resolves when the action is complete. * @returns {Promise<void>} Resolves when the action is complete.
*/ */
export async function run(): Promise<void> { export async function run(): Promise<void> {
try { try {
const loggerService = new LoggerService(); const loggerService = new LoggerService();
const inputService = new InputService(); const inputService = new InputService();
const dockerComposeService = new DockerComposeService(); const dockerComposeService = new DockerComposeService();
const inputs = inputService.getInputs(); const inputs = inputService.getInputs();
const { error, output } = await dockerComposeService.logs({ const { error, output } = await dockerComposeService.logs({
dockerFlags: inputs.dockerFlags, dockerFlags: inputs.dockerFlags,
composeFiles: inputs.composeFiles, composeFiles: inputs.composeFiles,
composeFlags: inputs.composeFlags, composeFlags: inputs.composeFlags,
cwd: inputs.cwd, cwd: inputs.cwd,
services: inputs.services, services: inputs.services,
serviceLogger: loggerService.getServiceLogger(inputs.serviceLogLevel), serviceLogger: loggerService.getServiceLogger(inputs.serviceLogLevel),
}); });
if (error) { if (error) {
loggerService.debug("docker compose error:\n" + error); loggerService.debug(`docker compose error:\n${error}`);
} }
loggerService.debug("docker compose logs:\n" + output); loggerService.debug(`docker compose logs:\n${output}`);
await dockerComposeService.down({ await dockerComposeService.down({
dockerFlags: inputs.dockerFlags, dockerFlags: inputs.dockerFlags,
composeFiles: inputs.composeFiles, composeFiles: inputs.composeFiles,
composeFlags: inputs.composeFlags, composeFlags: inputs.composeFlags,
cwd: inputs.cwd, cwd: inputs.cwd,
downFlags: inputs.downFlags, downFlags: inputs.downFlags,
serviceLogger: loggerService.getServiceLogger(inputs.serviceLogLevel), serviceLogger: loggerService.getServiceLogger(inputs.serviceLogLevel),
}); });
loggerService.info("docker compose is down"); loggerService.info("docker compose is down");
} catch (error) { } catch (error) {
setFailed(`${error instanceof Error ? error : JSON.stringify(error)}`); setFailed(`${error instanceof Error ? error : JSON.stringify(error)}`);
} }
} }

134
src/post.test.ts
View File

@ -1,15 +1,15 @@
import { describe, expect, it, beforeEach, vi } from "vitest"; import { beforeEach, describe, expect, it, vi } from "vitest";
// Mock @actions/core // Mock @actions/core
const setFailedMock = vi.fn(); const setFailedMock = vi.fn();
vi.doMock("@actions/core", () => ({ vi.doMock("@actions/core", () => ({
setFailed: setFailedMock, setFailed: setFailedMock,
getInput: vi.fn().mockReturnValue(""), getInput: vi.fn().mockReturnValue(""),
getMultilineInput: vi.fn().mockReturnValue([]), getMultilineInput: vi.fn().mockReturnValue([]),
debug: vi.fn(), debug: vi.fn(),
info: vi.fn(), info: vi.fn(),
warning: vi.fn(), warning: vi.fn(),
})); }));
// Mock docker-compose // Mock docker-compose
@ -17,25 +17,25 @@ const logsMock = vi.fn();
const downMock = vi.fn(); const downMock = vi.fn();
vi.doMock("docker-compose", () => ({ vi.doMock("docker-compose", () => ({
logs: logsMock, logs: logsMock,
down: downMock, down: downMock,
upAll: vi.fn(), upAll: vi.fn(),
upMany: vi.fn(), upMany: vi.fn(),
})); }));
// Mock node:fs // Mock node:fs
vi.doMock("node:fs", () => ({ vi.doMock("node:fs", () => ({
existsSync: vi.fn().mockReturnValue(true), existsSync: vi.fn().mockReturnValue(true),
default: { existsSync: vi.fn().mockReturnValue(true) }, default: { existsSync: vi.fn().mockReturnValue(true) },
})); }));
// Dynamic imports after mock setup // Dynamic imports after mock setup
const { InputService } = await import("./services/input.service.js"); const { InputService } = await import("./services/input.service.js");
const { LoggerService, LogLevel } = await import( const { LoggerService, LogLevel } = await import(
"./services/logger.service.js" "./services/logger.service.js"
); );
const { DockerComposeService } = await import( const { DockerComposeService } = await import(
"./services/docker-compose.service.js" "./services/docker-compose.service.js"
); );
let getInputsMock: ReturnType<typeof vi.spyOn>; let getInputsMock: ReturnType<typeof vi.spyOn>;
@ -45,64 +45,64 @@ let serviceLogsMock: ReturnType<typeof vi.spyOn>;
let serviceDownMock: ReturnType<typeof vi.spyOn>; let serviceDownMock: ReturnType<typeof vi.spyOn>;
describe("post", () => { describe("post", () => {
beforeEach(() => { beforeEach(() => {
vi.clearAllMocks(); vi.clearAllMocks();
infoMock = vi infoMock = vi
.spyOn(LoggerService.prototype, "info") .spyOn(LoggerService.prototype, "info")
.mockImplementation(() => {}); .mockImplementation(() => {});
debugMock = vi debugMock = vi
.spyOn(LoggerService.prototype, "debug") .spyOn(LoggerService.prototype, "debug")
.mockImplementation(() => {}); .mockImplementation(() => {});
getInputsMock = vi.spyOn(InputService.prototype, "getInputs"); getInputsMock = vi.spyOn(InputService.prototype, "getInputs");
serviceLogsMock = vi.spyOn(DockerComposeService.prototype, "logs"); serviceLogsMock = vi.spyOn(DockerComposeService.prototype, "logs");
serviceDownMock = vi.spyOn(DockerComposeService.prototype, "down"); serviceDownMock = vi.spyOn(DockerComposeService.prototype, "down");
}); });
it("calls run when imported", async () => { it("calls run when imported", async () => {
getInputsMock.mockImplementation(() => ({ getInputsMock.mockImplementation(() => ({
dockerFlags: [], dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: [], services: [],
composeFlags: [], composeFlags: [],
upFlags: [], upFlags: [],
downFlags: [], downFlags: [],
cwd: "/current/working/dir", cwd: "/current/working/dir",
composeVersion: null, composeVersion: null,
githubToken: null, githubToken: null,
serviceLogLevel: LogLevel.Debug, serviceLogLevel: LogLevel.Debug,
})); }));
serviceLogsMock.mockResolvedValue({ error: "", output: "test logs" }); serviceLogsMock.mockResolvedValue({ error: "", output: "test logs" });
serviceDownMock.mockResolvedValueOnce(); serviceDownMock.mockResolvedValueOnce();
await import("./post.js"); await import("./post.js");
await new Promise((resolve) => setTimeout(resolve, 0)); await new Promise((resolve) => setTimeout(resolve, 0));
expect(serviceLogsMock).toHaveBeenCalledWith({ expect(serviceLogsMock).toHaveBeenCalledWith({
dockerFlags: [], dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
composeFlags: [], composeFlags: [],
cwd: "/current/working/dir", cwd: "/current/working/dir",
services: [], services: [],
serviceLogger: debugMock, serviceLogger: debugMock,
}); });
expect(serviceDownMock).toHaveBeenCalledWith({ expect(serviceDownMock).toHaveBeenCalledWith({
dockerFlags: [], dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
composeFlags: [], composeFlags: [],
cwd: "/current/working/dir", cwd: "/current/working/dir",
downFlags: [], downFlags: [],
serviceLogger: debugMock, serviceLogger: debugMock,
}); });
expect(debugMock).toHaveBeenNthCalledWith( expect(debugMock).toHaveBeenNthCalledWith(
1, 1,
"docker compose logs:\ntest logs", "docker compose logs:\ntest logs",
); );
expect(infoMock).toHaveBeenNthCalledWith(1, "docker compose is down"); expect(infoMock).toHaveBeenNthCalledWith(1, "docker compose is down");
expect(setFailedMock).not.toHaveBeenCalled(); expect(setFailedMock).not.toHaveBeenCalled();
}); });
}); });

464
src/services/docker-compose-installer.service.test.ts
View File

@ -1,302 +1,302 @@
import { describe, it, expect, beforeEach, afterEach, vi } from "vitest";
import type { IDockerComposeResult } from "docker-compose"; import type { IDockerComposeResult } from "docker-compose";
import { MockAgent, setGlobalDispatcher } from "undici"; import { MockAgent, setGlobalDispatcher } from "undici";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
// Mock docker-compose before importing the module under test // Mock docker-compose before importing the module under test
const versionMock = const versionMock =
vi.fn<() => Promise<IDockerComposeResult & { data: { version: string } }>>(); vi.fn<() => Promise<IDockerComposeResult & { data: { version: string } }>>();
vi.doMock("docker-compose", () => ({ vi.doMock("docker-compose", () => ({
version: versionMock, version: versionMock,
})); }));
// Create manual installer adapter mock // Create manual installer adapter mock
const manualInstallerAdapterMock = { const manualInstallerAdapterMock = {
install: vi.fn<(version: string) => Promise<void>>(), install: vi.fn<(version: string) => Promise<void>>(),
}; };
// Dynamic import after mock setup // Dynamic import after mock setup
const { DockerComposeInstallerService } = await import( const { DockerComposeInstallerService } = await import(
"./docker-compose-installer.service.js" "./docker-compose-installer.service.js"
); );
describe("DockerComposeInstallerService", () => { describe("DockerComposeInstallerService", () => {
let mockAgent: MockAgent; let mockAgent: MockAgent;
let service: InstanceType<typeof DockerComposeInstallerService>; let service: InstanceType<typeof DockerComposeInstallerService>;
const composeVersionResponse = (version: string) => ({ const composeVersionResponse = (version: string) => ({
exitCode: 0, exitCode: 0,
out: "", out: "",
err: "", err: "",
data: { data: {
version, version,
}, },
}); });
const installCompose = ( const installCompose = (
composeVersion: string | null, composeVersion: string | null,
githubToken: string | null, githubToken: string | null,
) => ) =>
service.install({ service.install({
composeVersion, composeVersion,
cwd: "/path/to/cwd", cwd: "/path/to/cwd",
githubToken, githubToken,
}); });
const setPlatform = (platform: NodeJS.Platform) => { const setPlatform = (platform: NodeJS.Platform) => {
Object.defineProperty(process, "platform", { Object.defineProperty(process, "platform", {
value: platform, value: platform,
}); });
}; };
const mockLatestRelease = (version: string) => { const mockLatestRelease = (version: string) => {
const mockClient = mockAgent.get("https://api.github.com"); const mockClient = mockAgent.get("https://api.github.com");
mockClient mockClient
.intercept({ .intercept({
path: "/repos/docker/compose/releases/latest", path: "/repos/docker/compose/releases/latest",
method: "GET", method: "GET",
}) })
.reply( .reply(
200, 200,
{ {
tag_name: version, tag_name: version,
}, },
{ {
headers: { headers: {
"content-type": "application/json", "content-type": "application/json",
}, },
}, },
); );
setGlobalDispatcher(mockClient); setGlobalDispatcher(mockClient);
Object.defineProperty(globalThis, "fetch", { Object.defineProperty(globalThis, "fetch", {
value: vi.fn(), value: vi.fn(),
}); });
}; };
beforeEach(() => { beforeEach(() => {
vi.clearAllMocks(); vi.clearAllMocks();
mockAgent = new MockAgent(); mockAgent = new MockAgent();
mockAgent.disableNetConnect(); mockAgent.disableNetConnect();
service = new DockerComposeInstallerService( service = new DockerComposeInstallerService(
manualInstallerAdapterMock as never, manualInstallerAdapterMock as never,
); );
}); });
afterEach(() => { afterEach(() => {
vi.resetAllMocks(); vi.resetAllMocks();
}); });
describe("install", () => { describe("install", () => {
it("should install latest when compose version is not specified and Compose is missing", async () => { it("should install latest when compose version is not specified and Compose is missing", async () => {
// Arrange: first call to version() fails (Compose missing) // Arrange: first call to version() fails (Compose missing)
versionMock.mockRejectedValueOnce(new Error("version not installed")); versionMock.mockRejectedValueOnce(new Error("version not installed"));
const latestVersion = "v2.0.0"; const latestVersion = "v2.0.0";
mockLatestRelease(latestVersion); mockLatestRelease(latestVersion);
versionMock.mockResolvedValueOnce(composeVersionResponse(latestVersion)); versionMock.mockResolvedValueOnce(composeVersionResponse(latestVersion));
setPlatform("linux"); setPlatform("linux");
// Act // Act
const result = await installCompose(null, "token"); const result = await installCompose(null, "token");
// Assert // Assert
expect(result).toBe(latestVersion); expect(result).toBe(latestVersion);
expect(manualInstallerAdapterMock.install).toHaveBeenCalledWith( expect(manualInstallerAdapterMock.install).toHaveBeenCalledWith(
latestVersion, latestVersion,
); );
}); });
it("should return current version when no version is provided", async () => { it("should return current version when no version is provided", async () => {
// Arrange // Arrange
versionMock.mockResolvedValue(composeVersionResponse("2.0.0")); versionMock.mockResolvedValue(composeVersionResponse("2.0.0"));
// Act // Act
const result = await installCompose(null, null); const result = await installCompose(null, null);
// Assert // Assert
expect(result).toBe("2.0.0"); expect(result).toBe("2.0.0");
expect(manualInstallerAdapterMock.install).not.toHaveBeenCalled(); expect(manualInstallerAdapterMock.install).not.toHaveBeenCalled();
}); });
it("should not install anything when expected version is already installed", async () => { it("should not install anything when expected version is already installed", async () => {
// Arrange // Arrange
versionMock.mockResolvedValue(composeVersionResponse("1.2.3")); versionMock.mockResolvedValue(composeVersionResponse("1.2.3"));
// Act // Act
const result = await installCompose("v1.2.3", null); const result = await installCompose("v1.2.3", null);
// Assert // Assert
expect(result).toBe("1.2.3"); expect(result).toBe("1.2.3");
expect(manualInstallerAdapterMock.install).not.toHaveBeenCalled(); expect(manualInstallerAdapterMock.install).not.toHaveBeenCalled();
}); });
it("should install the requested version if it is not already installed", async () => { it("should install the requested version if it is not already installed", async () => {
// Arrange // Arrange
versionMock.mockResolvedValueOnce(composeVersionResponse("1.2.3")); versionMock.mockResolvedValueOnce(composeVersionResponse("1.2.3"));
const expectedVersion = "1.3.0"; const expectedVersion = "1.3.0";
versionMock.mockResolvedValueOnce( versionMock.mockResolvedValueOnce(
composeVersionResponse(expectedVersion), composeVersionResponse(expectedVersion),
); );
setPlatform("linux"); setPlatform("linux");
// Act // Act
const result = await installCompose(expectedVersion, null); const result = await installCompose(expectedVersion, null);
// Assert // Assert
expect(result).toBe(expectedVersion); expect(result).toBe(expectedVersion);
expect(manualInstallerAdapterMock.install).toHaveBeenCalledWith( expect(manualInstallerAdapterMock.install).toHaveBeenCalledWith(
expectedVersion, expectedVersion,
); );
}); });
it("should install the latest version if requested", async () => { it("should install the latest version if requested", async () => {
// Arrange // Arrange
versionMock.mockResolvedValueOnce(composeVersionResponse("1.2.3")); versionMock.mockResolvedValueOnce(composeVersionResponse("1.2.3"));
const latestVersion = "v1.4.0"; const latestVersion = "v1.4.0";
mockLatestRelease(latestVersion); mockLatestRelease(latestVersion);
versionMock.mockResolvedValueOnce(composeVersionResponse(latestVersion)); versionMock.mockResolvedValueOnce(composeVersionResponse(latestVersion));
setPlatform("linux"); setPlatform("linux");
// Act // Act
const result = await installCompose("latest", "token"); const result = await installCompose("latest", "token");
// Assert // Assert
expect(result).toBe(latestVersion); expect(result).toBe(latestVersion);
expect(manualInstallerAdapterMock.install).toHaveBeenCalledWith( expect(manualInstallerAdapterMock.install).toHaveBeenCalledWith(
latestVersion, latestVersion,
); );
}); });
it("should throw an error if the latest version if requested and no Github token is provided", async () => { it("should throw an error if the latest version if requested and no Github token is provided", async () => {
// Arrange // Arrange
versionMock.mockResolvedValueOnce(composeVersionResponse("1.2.3")); versionMock.mockResolvedValueOnce(composeVersionResponse("1.2.3"));
// Act & Assert // Act & Assert
await expect(installCompose("latest", null)).rejects.toThrow( await expect(installCompose("latest", null)).rejects.toThrow(
"GitHub token is required to install the latest version", "GitHub token is required to install the latest version",
); );
}); });
it("should throw an error on unsupported platforms", async () => { it("should throw an error on unsupported platforms", async () => {
// Arrange // Arrange
versionMock.mockResolvedValueOnce(composeVersionResponse("1.2.3")); versionMock.mockResolvedValueOnce(composeVersionResponse("1.2.3"));
const expectedVersion = "1.3.0"; const expectedVersion = "1.3.0";
versionMock.mockResolvedValueOnce( versionMock.mockResolvedValueOnce(
composeVersionResponse(expectedVersion), composeVersionResponse(expectedVersion),
); );
setPlatform("win32"); setPlatform("win32");
// Act & Assert // Act & Assert
await expect(installCompose(expectedVersion, null)).rejects.toThrow( await expect(installCompose(expectedVersion, null)).rejects.toThrow(
`Unsupported platform: win32`, `Unsupported platform: win32`,
); );
expect(manualInstallerAdapterMock.install).not.toHaveBeenCalled(); expect(manualInstallerAdapterMock.install).not.toHaveBeenCalled();
}); });
it("should install when version check fails", async () => { it("should install when version check fails", async () => {
// Arrange: first call to version() doesn't find // Arrange: first call to version() doesn't find
versionMock.mockRejectedValueOnce(new Error("version not installed")); versionMock.mockRejectedValueOnce(new Error("version not installed"));
const installedVersion = "2.0.0"; const installedVersion = "2.0.0";
// After installation, version() returns the new version // After installation, version() returns the new version
versionMock.mockResolvedValueOnce( versionMock.mockResolvedValueOnce(
composeVersionResponse(installedVersion), composeVersionResponse(installedVersion),
); );
setPlatform("linux"); setPlatform("linux");
// Act // Act
const result = await installCompose(installedVersion, "token"); const result = await installCompose(installedVersion, "token");
// Assert // Assert
expect(result).toBe(installedVersion); expect(result).toBe(installedVersion);
expect(manualInstallerAdapterMock.install).toHaveBeenCalledWith( expect(manualInstallerAdapterMock.install).toHaveBeenCalledWith(
installedVersion, installedVersion,
); );
}); });
it("should install latest version when missing or unspecified", async () => { it("should install latest version when missing or unspecified", async () => {
// Arrange: first call to version() doesn't find // Arrange: first call to version() doesn't find
versionMock.mockRejectedValueOnce(new Error("version check failed")); versionMock.mockRejectedValueOnce(new Error("version check failed"));
// second call finds newly installed version // second call finds newly installed version
versionMock.mockResolvedValueOnce(composeVersionResponse("v1.4.0")); versionMock.mockResolvedValueOnce(composeVersionResponse("v1.4.0"));
const latestVersion = "v1.4.0"; const latestVersion = "v1.4.0";
mockLatestRelease(latestVersion); mockLatestRelease(latestVersion);
versionMock.mockResolvedValueOnce(composeVersionResponse(latestVersion)); versionMock.mockResolvedValueOnce(composeVersionResponse(latestVersion));
setPlatform("linux"); setPlatform("linux");
// Act // Act
const result = await installCompose("latest", "token"); const result = await installCompose("latest", "token");
// Assert // Assert
expect(result).toBe(latestVersion); expect(result).toBe(latestVersion);
expect(manualInstallerAdapterMock.install).toHaveBeenCalledWith( expect(manualInstallerAdapterMock.install).toHaveBeenCalledWith(
latestVersion, latestVersion,
); );
}); });
it("should throw if Compose is missing and no GitHub token is provided", async () => { it("should throw if Compose is missing and no GitHub token is provided", async () => {
// Arrange: first call to version() doesn't find // Arrange: first call to version() doesn't find
versionMock.mockRejectedValueOnce(new Error("version check failed")); versionMock.mockRejectedValueOnce(new Error("version check failed"));
setPlatform("linux"); setPlatform("linux");
await expect(installCompose("latest", null)).rejects.toThrow( await expect(installCompose("latest", null)).rejects.toThrow(
"GitHub token is required to install the latest version", "GitHub token is required to install the latest version",
); );
}); });
it("should not install when the version is already installed and no version is specified", async () => { it("should not install when the version is already installed and no version is specified", async () => {
// Arrange // Arrange
versionMock.mockResolvedValue(composeVersionResponse("1.2.3")); versionMock.mockResolvedValue(composeVersionResponse("1.2.3"));
// Act // Act
const result = await installCompose("", null); const result = await installCompose("", null);
// Assert // Assert
expect(result).toBe("1.2.3"); expect(result).toBe("1.2.3");
expect(manualInstallerAdapterMock.install).not.toHaveBeenCalled(); expect(manualInstallerAdapterMock.install).not.toHaveBeenCalled();
}); });
it("should throw when installed version does not match target", async () => { it("should throw when installed version does not match target", async () => {
// Arrange // Arrange
versionMock.mockResolvedValueOnce(composeVersionResponse("1.2.3")); versionMock.mockResolvedValueOnce(composeVersionResponse("1.2.3"));
const targetVersion = "v1.4.0"; const targetVersion = "v1.4.0";
versionMock.mockResolvedValueOnce(composeVersionResponse("1.3.0")); versionMock.mockResolvedValueOnce(composeVersionResponse("1.3.0"));
setPlatform("linux"); setPlatform("linux");
// Act & Assert // Act & Assert
await expect(installCompose(targetVersion, "token")).rejects.toThrow( await expect(installCompose(targetVersion, "token")).rejects.toThrow(
`Failed to install Docker Compose version "${targetVersion}", installed version is "1.3.0"`, `Failed to install Docker Compose version "${targetVersion}", installed version is "1.3.0"`,
); );
expect(manualInstallerAdapterMock.install).toHaveBeenCalledWith( expect(manualInstallerAdapterMock.install).toHaveBeenCalledWith(
targetVersion, targetVersion,
); );
}); });
it("should throw with unknown installed version when post-install version check fails", async () => { it("should throw with unknown installed version when post-install version check fails", async () => {
// Arrange // Arrange
versionMock.mockResolvedValueOnce(composeVersionResponse("1.2.3")); versionMock.mockResolvedValueOnce(composeVersionResponse("1.2.3"));
const targetVersion = "v1.4.0"; const targetVersion = "v1.4.0";
versionMock.mockRejectedValueOnce( versionMock.mockRejectedValueOnce(
new Error("version check failed after install"), new Error("version check failed after install"),
); );
setPlatform("linux"); setPlatform("linux");
// Act & Assert // Act & Assert
await expect(installCompose(targetVersion, "token")).rejects.toThrow( await expect(installCompose(targetVersion, "token")).rejects.toThrow(
`Failed to install Docker Compose version "${targetVersion}", installed version is "unknown"`, `Failed to install Docker Compose version "${targetVersion}", installed version is "unknown"`,
); );
expect(manualInstallerAdapterMock.install).toHaveBeenCalledWith( expect(manualInstallerAdapterMock.install).toHaveBeenCalledWith(
targetVersion, targetVersion,
); );
}); });
}); });
}); });

160
src/services/docker-compose-installer.service.ts
View File

@ -4,105 +4,105 @@ import { COMPOSE_VERSION_LATEST, type Inputs } from "./input.service.js";
import type { ManualInstallerAdapter } from "./installer-adapter/manual-installer-adapter.js"; import type { ManualInstallerAdapter } from "./installer-adapter/manual-installer-adapter.js";
export type InstallInputs = { export type InstallInputs = {
composeVersion: Inputs["composeVersion"]; composeVersion: Inputs["composeVersion"];
cwd: Inputs["cwd"]; cwd: Inputs["cwd"];
githubToken: Inputs["githubToken"]; githubToken: Inputs["githubToken"];
}; };
export type VersionInputs = { export type VersionInputs = {
cwd: Inputs["cwd"]; cwd: Inputs["cwd"];
}; };
export class DockerComposeInstallerService { export class DockerComposeInstallerService {
constructor( constructor(
private readonly manualInstallerAdapter: ManualInstallerAdapter, private readonly manualInstallerAdapter: ManualInstallerAdapter,
) {} ) {}
async install({ async install({
composeVersion, composeVersion,
cwd, cwd,
githubToken, githubToken,
}: InstallInputs): Promise<string> { }: InstallInputs): Promise<string> {
const currentVersion = await this.version({ cwd }); const currentVersion = await this.version({ cwd });
const normalizedCurrentVersion = currentVersion const normalizedCurrentVersion = currentVersion
? this.normalizeVersion(currentVersion) ? this.normalizeVersion(currentVersion)
: null; : null;
const normalizedRequestedVersion = composeVersion const normalizedRequestedVersion = composeVersion
? this.normalizeVersion(composeVersion) ? this.normalizeVersion(composeVersion)
: null; : null;
const needsInstall = const needsInstall =
!currentVersion || !currentVersion ||
(composeVersion && (composeVersion &&
normalizedRequestedVersion !== normalizedCurrentVersion); normalizedRequestedVersion !== normalizedCurrentVersion);
if (!needsInstall) { if (!needsInstall) {
return currentVersion; return currentVersion;
} }
let targetVersion = composeVersion || COMPOSE_VERSION_LATEST; let targetVersion = composeVersion || COMPOSE_VERSION_LATEST;
if (targetVersion === COMPOSE_VERSION_LATEST) { if (targetVersion === COMPOSE_VERSION_LATEST) {
if (!githubToken) { if (!githubToken) {
throw new Error( throw new Error(
"GitHub token is required to install the latest version", "GitHub token is required to install the latest version",
); );
} }
targetVersion = await this.getLatestVersion(githubToken); targetVersion = await this.getLatestVersion(githubToken);
} }
await this.installVersion(targetVersion); await this.installVersion(targetVersion);
const installedVersion = await this.version({ cwd }); const installedVersion = await this.version({ cwd });
if ( if (
!installedVersion || !installedVersion ||
this.normalizeVersion(installedVersion) !== this.normalizeVersion(installedVersion) !==
this.normalizeVersion(targetVersion) this.normalizeVersion(targetVersion)
) { ) {
throw new Error( throw new Error(
`Failed to install Docker Compose version "${targetVersion}", installed version is "${installedVersion ?? "unknown"}"`, `Failed to install Docker Compose version "${targetVersion}", installed version is "${installedVersion ?? "unknown"}"`,
); );
} }
return installedVersion; return installedVersion;
} }
private async version({ cwd }: VersionInputs): Promise<string | null> { private async version({ cwd }: VersionInputs): Promise<string | null> {
try { try {
const result = await version({ const result = await version({
cwd, cwd,
}); });
return result.data.version; return result.data.version;
} catch { } catch {
// If version check fails (e.g., Docker Compose not installed), return null // If version check fails (e.g., Docker Compose not installed), return null
return null; return null;
} }
} }
private async getLatestVersion(githubToken: string): Promise<string> { private async getLatestVersion(githubToken: string): Promise<string> {
const octokit = github.getOctokit(githubToken); const octokit = github.getOctokit(githubToken);
const response = await octokit.rest.repos.getLatestRelease({ const response = await octokit.rest.repos.getLatestRelease({
owner: "docker", owner: "docker",
repo: "compose", repo: "compose",
}); });
return response.data.tag_name; return response.data.tag_name;
} }
private normalizeVersion(version: string): string { private normalizeVersion(version: string): string {
return version.replace(/^v/i, ""); return version.replace(/^v/i, "");
} }
private async installVersion(version: string): Promise<void> { private async installVersion(version: string): Promise<void> {
switch (process.platform) { switch (process.platform) {
case "linux": case "linux":
case "darwin": case "darwin":
await this.manualInstallerAdapter.install(version); await this.manualInstallerAdapter.install(version);
break; break;
default: default:
throw new Error(`Unsupported platform: ${process.platform}`); throw new Error(`Unsupported platform: ${process.platform}`);
} }
} }
} }

640
src/services/docker-compose.service.test.ts
View File

@ -1,391 +1,391 @@
import { describe, expect, it, beforeEach, vi } from "vitest";
import type { import type {
IDockerComposeLogOptions, IDockerComposeLogOptions,
IDockerComposeOptions, IDockerComposeOptions,
IDockerComposeResult, IDockerComposeResult,
} from "docker-compose"; } from "docker-compose";
import { beforeEach, describe, expect, it, vi } from "vitest";
// Mock docker-compose before importing the module under test // Mock docker-compose before importing the module under test
const upAllMock = const upAllMock =
vi.fn<(options: IDockerComposeOptions) => Promise<IDockerComposeResult>>(); vi.fn<(options: IDockerComposeOptions) => Promise<IDockerComposeResult>>();
const upManyMock = const upManyMock =
vi.fn< vi.fn<
( (
services: string[], services: string[],
options: IDockerComposeOptions, options: IDockerComposeOptions,
) => Promise<IDockerComposeResult> ) => Promise<IDockerComposeResult>
>(); >();
const downMock = const downMock =
vi.fn<(options: IDockerComposeOptions) => Promise<IDockerComposeResult>>(); vi.fn<(options: IDockerComposeOptions) => Promise<IDockerComposeResult>>();
const logsMock = const logsMock =
vi.fn< vi.fn<
( (
services: string[], services: string[],
options: IDockerComposeLogOptions, options: IDockerComposeLogOptions,
) => Promise<IDockerComposeResult> ) => Promise<IDockerComposeResult>
>(); >();
vi.doMock("docker-compose", () => ({ vi.doMock("docker-compose", () => ({
upAll: upAllMock, upAll: upAllMock,
upMany: upManyMock, upMany: upManyMock,
down: downMock, down: downMock,
logs: logsMock, logs: logsMock,
})); }));
// Dynamic import after mock setup // Dynamic import after mock setup
const { DockerComposeService } = await import("./docker-compose.service.js"); const { DockerComposeService } = await import("./docker-compose.service.js");
describe("DockerComposeService", () => { describe("DockerComposeService", () => {
let service: InstanceType<typeof DockerComposeService>; let service: InstanceType<typeof DockerComposeService>;
beforeEach(() => { beforeEach(() => {
vi.clearAllMocks(); vi.clearAllMocks();
service = new DockerComposeService(); service = new DockerComposeService();
}); });
describe("up", () => { describe("up", () => {
it("should call up with correct options", async () => { it("should call up with correct options", async () => {
const upInputs = { const upInputs = {
dockerFlags: [] as string[], dockerFlags: [] as string[],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: [] as string[], services: [] as string[],
composeFlags: [] as string[], composeFlags: [] as string[],
upFlags: [] as string[], upFlags: [] as string[],
cwd: "/current/working/dir", cwd: "/current/working/dir",
serviceLogger: vi.fn(), serviceLogger: vi.fn(),
}; };
upAllMock.mockResolvedValue({ exitCode: 0, err: "", out: "" }); upAllMock.mockResolvedValue({ exitCode: 0, err: "", out: "" });
await service.up(upInputs); await service.up(upInputs);
expect(upAllMock).toHaveBeenCalledWith({ expect(upAllMock).toHaveBeenCalledWith({
composeOptions: [], composeOptions: [],
commandOptions: [], commandOptions: [],
config: ["docker-compose.yml"], config: ["docker-compose.yml"],
executable: { executable: {
executablePath: "docker", executablePath: "docker",
options: [], options: [],
}, },
cwd: "/current/working/dir", cwd: "/current/working/dir",
callback: expect.any(Function), callback: expect.any(Function),
}); });
// Ensure callback is calling the service logger // Ensure callback is calling the service logger
const callback = (upAllMock.mock.calls[0][0] as IDockerComposeOptions) const callback = (upAllMock.mock.calls[0][0] as IDockerComposeOptions)
?.callback; ?.callback;
expect(callback).toBeDefined(); expect(callback).toBeDefined();
const message = "test log output"; const message = "test log output";
if (callback) { if (callback) {
callback(Buffer.from(message)); callback(Buffer.from(message));
} }
expect(upInputs.serviceLogger).toHaveBeenCalledWith("test log output"); expect(upInputs.serviceLogger).toHaveBeenCalledWith("test log output");
}); });
it("should call up with specific docker flags", async () => { it("should call up with specific docker flags", async () => {
const upInputs = { const upInputs = {
dockerFlags: ["--context", "dev"], dockerFlags: ["--context", "dev"],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: [] as string[], services: [] as string[],
composeFlags: [] as string[], composeFlags: [] as string[],
upFlags: [] as string[], upFlags: [] as string[],
cwd: "/current/working/dir", cwd: "/current/working/dir",
serviceLogger: vi.fn(), serviceLogger: vi.fn(),
}; };
upAllMock.mockResolvedValue({ exitCode: 0, err: "", out: "" }); upAllMock.mockResolvedValue({ exitCode: 0, err: "", out: "" });
await service.up(upInputs); await service.up(upInputs);
expect(upAllMock).toHaveBeenCalledWith({ expect(upAllMock).toHaveBeenCalledWith({
composeOptions: [], composeOptions: [],
commandOptions: [], commandOptions: [],
config: ["docker-compose.yml"], config: ["docker-compose.yml"],
executable: { executable: {
executablePath: "docker", executablePath: "docker",
options: ["--context", "dev"], options: ["--context", "dev"],
}, },
cwd: "/current/working/dir", cwd: "/current/working/dir",
callback: expect.any(Function), callback: expect.any(Function),
}); });
}); });
it("should call up with specific services", async () => { it("should call up with specific services", async () => {
const upInputs = { const upInputs = {
dockerFlags: [] as string[], dockerFlags: [] as string[],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: ["helloworld2", "helloworld3"], services: ["helloworld2", "helloworld3"],
composeFlags: [] as string[], composeFlags: [] as string[],
upFlags: ["--build"], upFlags: ["--build"],
cwd: "/current/working/dir", cwd: "/current/working/dir",
serviceLogger: vi.fn(), serviceLogger: vi.fn(),
}; };
upManyMock.mockResolvedValue({ exitCode: 0, err: "", out: "" }); upManyMock.mockResolvedValue({ exitCode: 0, err: "", out: "" });
await service.up(upInputs); await service.up(upInputs);
expect(upManyMock).toHaveBeenCalledWith(["helloworld2", "helloworld3"], { expect(upManyMock).toHaveBeenCalledWith(["helloworld2", "helloworld3"], {
composeOptions: [], composeOptions: [],
commandOptions: ["--build"], commandOptions: ["--build"],
config: ["docker-compose.yml"], config: ["docker-compose.yml"],
cwd: "/current/working/dir", cwd: "/current/working/dir",
callback: expect.any(Function), callback: expect.any(Function),
executable: { executable: {
executablePath: "docker", executablePath: "docker",
options: [], options: [],
}, },
}); });
}); });
it("should throw formatted error when upAll fails with docker-compose result", async () => { it("should throw formatted error when upAll fails with docker-compose result", async () => {
const upInputs = { const upInputs = {
dockerFlags: [] as string[], dockerFlags: [] as string[],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: [] as string[], services: [] as string[],
composeFlags: [] as string[], composeFlags: [] as string[],
upFlags: [] as string[], upFlags: [] as string[],
cwd: "/current/working/dir", cwd: "/current/working/dir",
serviceLogger: vi.fn(), serviceLogger: vi.fn(),
}; };
const dockerComposeError = { const dockerComposeError = {
exitCode: 1, exitCode: 1,
err: "Error: unable to pull image\nfailed to resolve reference", err: "Error: unable to pull image\nfailed to resolve reference",
out: "", out: "",
}; };
upAllMock.mockRejectedValue(dockerComposeError); upAllMock.mockRejectedValue(dockerComposeError);
await expect(service.up(upInputs)).rejects.toThrow( await expect(service.up(upInputs)).rejects.toThrow(
"Docker Compose command failed with exit code 1", "Docker Compose command failed with exit code 1",
); );
await expect(service.up(upInputs)).rejects.toThrow( await expect(service.up(upInputs)).rejects.toThrow(
"unable to pull image", "unable to pull image",
); );
}); });
it("should throw formatted error when upMany fails with docker-compose result", async () => { it("should throw formatted error when upMany fails with docker-compose result", async () => {
const upInputs = { const upInputs = {
dockerFlags: [] as string[], dockerFlags: [] as string[],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: ["web"], services: ["web"],
composeFlags: [] as string[], composeFlags: [] as string[],
upFlags: [] as string[], upFlags: [] as string[],
cwd: "/current/working/dir", cwd: "/current/working/dir",
serviceLogger: vi.fn(), serviceLogger: vi.fn(),
}; };
const dockerComposeError = { const dockerComposeError = {
exitCode: 1, exitCode: 1,
err: "Service 'web' failed to start", err: "Service 'web' failed to start",
out: "Starting web...", out: "Starting web...",
}; };
upManyMock.mockRejectedValue(dockerComposeError); upManyMock.mockRejectedValue(dockerComposeError);
await expect(service.up(upInputs)).rejects.toThrow( await expect(service.up(upInputs)).rejects.toThrow(
"Docker Compose command failed with exit code 1", "Docker Compose command failed with exit code 1",
); );
await expect(service.up(upInputs)).rejects.toThrow( await expect(service.up(upInputs)).rejects.toThrow(
"Service 'web' failed to start", "Service 'web' failed to start",
); );
await expect(service.up(upInputs)).rejects.toThrow("Starting web..."); await expect(service.up(upInputs)).rejects.toThrow("Starting web...");
}); });
it("should pass through docker-compose result without exit code", async () => { it("should pass through docker-compose result without exit code", async () => {
const upInputs = { const upInputs = {
dockerFlags: [] as string[], dockerFlags: [] as string[],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: [] as string[], services: [] as string[],
composeFlags: [] as string[], composeFlags: [] as string[],
upFlags: [] as string[], upFlags: [] as string[],
cwd: "/current/working/dir", cwd: "/current/working/dir",
serviceLogger: vi.fn(), serviceLogger: vi.fn(),
}; };
const dockerComposeError = { const dockerComposeError = {
exitCode: null, exitCode: null,
err: "Some error without exit code", err: "Some error without exit code",
out: "", out: "",
}; };
upAllMock.mockRejectedValue(dockerComposeError); upAllMock.mockRejectedValue(dockerComposeError);
await expect(service.up(upInputs)).rejects.toThrow( await expect(service.up(upInputs)).rejects.toThrow(
"Some error without exit code", "Some error without exit code",
); );
}); });
it("should format docker-compose result when streams are undefined", async () => { it("should format docker-compose result when streams are undefined", async () => {
const upInputs = { const upInputs = {
dockerFlags: [] as string[], dockerFlags: [] as string[],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: [] as string[], services: [] as string[],
composeFlags: [] as string[], composeFlags: [] as string[],
upFlags: [] as string[], upFlags: [] as string[],
cwd: "/current/working/dir", cwd: "/current/working/dir",
serviceLogger: vi.fn(), serviceLogger: vi.fn(),
}; };
const dockerComposeError = { const dockerComposeError = {
exitCode: 1, exitCode: 1,
err: undefined, err: undefined,
out: undefined, out: undefined,
}; };
upAllMock.mockRejectedValue(dockerComposeError); upAllMock.mockRejectedValue(dockerComposeError);
await expect(service.up(upInputs)).rejects.toThrow( await expect(service.up(upInputs)).rejects.toThrow(
"Docker Compose command failed with exit code 1", "Docker Compose command failed with exit code 1",
); );
await expect(service.up(upInputs)).rejects.not.toThrow("Error output:"); await expect(service.up(upInputs)).rejects.not.toThrow("Error output:");
await expect(service.up(upInputs)).rejects.not.toThrow( await expect(service.up(upInputs)).rejects.not.toThrow(
"Standard output:", "Standard output:",
); );
}); });
it("should pass through standard Error objects", async () => { it("should pass through standard Error objects", async () => {
const upInputs = { const upInputs = {
dockerFlags: [] as string[], dockerFlags: [] as string[],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: [] as string[], services: [] as string[],
composeFlags: [] as string[], composeFlags: [] as string[],
upFlags: [] as string[], upFlags: [] as string[],
cwd: "/current/working/dir", cwd: "/current/working/dir",
serviceLogger: vi.fn(), serviceLogger: vi.fn(),
}; };
const standardError = new Error("Standard error message"); const standardError = new Error("Standard error message");
upAllMock.mockRejectedValue(standardError); upAllMock.mockRejectedValue(standardError);
await expect(service.up(upInputs)).rejects.toThrow( await expect(service.up(upInputs)).rejects.toThrow(
"Standard error message", "Standard error message",
); );
}); });
it("should pass through error strings", async () => { it("should pass through error strings", async () => {
const upInputs = { const upInputs = {
dockerFlags: [] as string[], dockerFlags: [] as string[],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: [] as string[], services: [] as string[],
composeFlags: [] as string[], composeFlags: [] as string[],
upFlags: [] as string[], upFlags: [] as string[],
cwd: "/current/working/dir", cwd: "/current/working/dir",
serviceLogger: vi.fn(), serviceLogger: vi.fn(),
}; };
const unknownError = "Some unknown error"; const unknownError = "Some unknown error";
upAllMock.mockRejectedValue(unknownError); upAllMock.mockRejectedValue(unknownError);
await expect(service.up(upInputs)).rejects.toThrow("Some unknown error"); await expect(service.up(upInputs)).rejects.toThrow("Some unknown error");
}); });
it("should handle unknown error types gracefully", async () => { it("should handle unknown error types gracefully", async () => {
const upInputs = { const upInputs = {
dockerFlags: [] as string[], dockerFlags: [] as string[],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: [] as string[], services: [] as string[],
composeFlags: [] as string[], composeFlags: [] as string[],
upFlags: [] as string[], upFlags: [] as string[],
cwd: "/current/working/dir", cwd: "/current/working/dir",
serviceLogger: vi.fn(), serviceLogger: vi.fn(),
}; };
const unknownError = { unexpected: "error format" }; const unknownError = { unexpected: "error format" };
upAllMock.mockRejectedValue(unknownError); upAllMock.mockRejectedValue(unknownError);
await expect(service.up(upInputs)).rejects.toThrow( await expect(service.up(upInputs)).rejects.toThrow(
JSON.stringify(unknownError), JSON.stringify(unknownError),
); );
}); });
}); });
describe("down", () => { describe("down", () => {
it("should call down with correct options", async () => { it("should call down with correct options", async () => {
const downInputs = { const downInputs = {
dockerFlags: [] as string[], dockerFlags: [] as string[],
composeFiles: [] as string[], composeFiles: [] as string[],
composeFlags: [] as string[], composeFlags: [] as string[],
downFlags: ["--volumes", "--remove-orphans"], downFlags: ["--volumes", "--remove-orphans"],
cwd: "/current/working/dir", cwd: "/current/working/dir",
serviceLogger: vi.fn(), serviceLogger: vi.fn(),
}; };
downMock.mockResolvedValue({ exitCode: 0, err: "", out: "" }); downMock.mockResolvedValue({ exitCode: 0, err: "", out: "" });
await service.down(downInputs); await service.down(downInputs);
expect(downMock).toHaveBeenCalledWith({ expect(downMock).toHaveBeenCalledWith({
composeOptions: [], composeOptions: [],
commandOptions: ["--volumes", "--remove-orphans"], commandOptions: ["--volumes", "--remove-orphans"],
config: [], config: [],
executable: { executable: {
executablePath: "docker", executablePath: "docker",
options: [], options: [],
}, },
cwd: "/current/working/dir", cwd: "/current/working/dir",
callback: expect.any(Function), callback: expect.any(Function),
}); });
}); });
it("should throw formatted error when down fails with docker-compose result", async () => { it("should throw formatted error when down fails with docker-compose result", async () => {
const downInputs = { const downInputs = {
dockerFlags: [] as string[], dockerFlags: [] as string[],
composeFiles: [] as string[], composeFiles: [] as string[],
composeFlags: [] as string[], composeFlags: [] as string[],
downFlags: [] as string[], downFlags: [] as string[],
cwd: "/current/working/dir", cwd: "/current/working/dir",
serviceLogger: vi.fn(), serviceLogger: vi.fn(),
}; };
const dockerComposeError = { const dockerComposeError = {
exitCode: 1, exitCode: 1,
err: "Error stopping containers", err: "Error stopping containers",
out: "", out: "",
}; };
downMock.mockRejectedValue(dockerComposeError); downMock.mockRejectedValue(dockerComposeError);
await expect(service.down(downInputs)).rejects.toThrow( await expect(service.down(downInputs)).rejects.toThrow(
"Docker Compose command failed with exit code 1", "Docker Compose command failed with exit code 1",
); );
await expect(service.down(downInputs)).rejects.toThrow( await expect(service.down(downInputs)).rejects.toThrow(
"Error stopping containers", "Error stopping containers",
); );
}); });
}); });
describe("logs", () => { describe("logs", () => {
it("should call logs with correct options", async () => { it("should call logs with correct options", async () => {
const debugMock = vi.fn(); const debugMock = vi.fn();
const logsInputs = { const logsInputs = {
dockerFlags: [] as string[], dockerFlags: [] as string[],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: ["helloworld2", "helloworld3"], services: ["helloworld2", "helloworld3"],
composeFlags: [] as string[], composeFlags: [] as string[],
cwd: "/current/working/dir", cwd: "/current/working/dir",
serviceLogger: debugMock, serviceLogger: debugMock,
}; };
logsMock.mockResolvedValue({ exitCode: 0, err: "", out: "logs" }); logsMock.mockResolvedValue({ exitCode: 0, err: "", out: "logs" });
await service.logs(logsInputs); await service.logs(logsInputs);
expect(logsMock).toHaveBeenCalledWith(["helloworld2", "helloworld3"], { expect(logsMock).toHaveBeenCalledWith(["helloworld2", "helloworld3"], {
composeOptions: [], composeOptions: [],
config: ["docker-compose.yml"], config: ["docker-compose.yml"],
cwd: "/current/working/dir", cwd: "/current/working/dir",
executable: { executable: {
executablePath: "docker", executablePath: "docker",
options: [], options: [],
}, },
follow: false, follow: false,
callback: expect.any(Function), callback: expect.any(Function),
}); });
}); });
}); });
}); });

244
src/services/docker-compose.service.ts
View File

@ -1,153 +1,153 @@
import { import {
down, down,
type IDockerComposeLogOptions, type IDockerComposeLogOptions,
type IDockerComposeOptions, type IDockerComposeOptions,
type IDockerComposeResult, type IDockerComposeResult,
logs, logs,
upAll, upAll,
upMany, upMany,
} from "docker-compose"; } from "docker-compose";
import type { Inputs } from "./input.service.js"; import type { Inputs } from "./input.service.js";
type OptionsInputs = { type OptionsInputs = {
dockerFlags: Inputs["dockerFlags"]; dockerFlags: Inputs["dockerFlags"];
composeFiles: Inputs["composeFiles"]; composeFiles: Inputs["composeFiles"];
composeFlags: Inputs["composeFlags"]; composeFlags: Inputs["composeFlags"];
cwd: Inputs["cwd"]; cwd: Inputs["cwd"];
serviceLogger: (message: string) => void; serviceLogger: (message: string) => void;
}; };
export type UpInputs = OptionsInputs & { export type UpInputs = OptionsInputs & {
upFlags: Inputs["upFlags"]; upFlags: Inputs["upFlags"];
services: Inputs["services"]; services: Inputs["services"];
}; };
export type DownInputs = OptionsInputs & { downFlags: Inputs["downFlags"] }; export type DownInputs = OptionsInputs & { downFlags: Inputs["downFlags"] };
export type LogsInputs = OptionsInputs & { services: Inputs["services"] }; export type LogsInputs = OptionsInputs & { services: Inputs["services"] };
export class DockerComposeService { export class DockerComposeService {
async up({ upFlags, services, ...optionsInputs }: UpInputs): Promise<void> { async up({ upFlags, services, ...optionsInputs }: UpInputs): Promise<void> {
const options: IDockerComposeOptions = { const options: IDockerComposeOptions = {
...this.getCommonOptions(optionsInputs), ...this.getCommonOptions(optionsInputs),
commandOptions: upFlags, commandOptions: upFlags,
}; };
try { try {
if (services.length > 0) { if (services.length > 0) {
await upMany(services, options); await upMany(services, options);
return; return;
} }
await upAll(options); await upAll(options);
} catch (error) { } catch (error) {
throw this.formatDockerComposeError(error); throw this.formatDockerComposeError(error);
} }
} }
async down({ downFlags, ...optionsInputs }: DownInputs): Promise<void> { async down({ downFlags, ...optionsInputs }: DownInputs): Promise<void> {
const options: IDockerComposeOptions = { const options: IDockerComposeOptions = {
...this.getCommonOptions(optionsInputs), ...this.getCommonOptions(optionsInputs),
commandOptions: downFlags, commandOptions: downFlags,
}; };
try { try {
await down(options); await down(options);
} catch (error) { } catch (error) {
throw this.formatDockerComposeError(error); throw this.formatDockerComposeError(error);
} }
} }
async logs({ services, ...optionsInputs }: LogsInputs): Promise<{ async logs({ services, ...optionsInputs }: LogsInputs): Promise<{
error: string; error: string;
output: string; output: string;
}> { }> {
const options: IDockerComposeLogOptions = { const options: IDockerComposeLogOptions = {
...this.getCommonOptions(optionsInputs), ...this.getCommonOptions(optionsInputs),
follow: false, follow: false,
}; };
const { err, out } = await logs(services, options); const { err, out } = await logs(services, options);
return { return {
error: err, error: err,
output: out, output: out,
}; };
} }
private getCommonOptions({ private getCommonOptions({
dockerFlags, dockerFlags,
composeFiles, composeFiles,
composeFlags, composeFlags,
cwd, cwd,
serviceLogger, serviceLogger,
}: OptionsInputs): IDockerComposeOptions { }: OptionsInputs): IDockerComposeOptions {
return { return {
config: composeFiles, config: composeFiles,
composeOptions: composeFlags, composeOptions: composeFlags,
cwd: cwd, cwd: cwd,
callback: (chunk) => serviceLogger(chunk.toString()), callback: (chunk) => serviceLogger(chunk.toString()),
executable: { executable: {
executablePath: "docker", executablePath: "docker",
options: dockerFlags, options: dockerFlags,
}, },
}; };
} }
/** /**
* Formats docker-compose errors into proper Error objects with readable messages * Formats docker-compose errors into proper Error objects with readable messages
*/ */
private formatDockerComposeError(error: unknown): Error { private formatDockerComposeError(error: unknown): Error {
// If it's already an Error, return it // If it's already an Error, return it
if (error instanceof Error) { if (error instanceof Error) {
return error; return error;
} }
// Handle docker-compose result objects // Handle docker-compose result objects
if (this.isDockerComposeResult(error)) { if (this.isDockerComposeResult(error)) {
const parts: string[] = []; const parts: string[] = [];
// Add exit code information // Add exit code information
if (error.exitCode !== null) { if (error.exitCode !== null) {
parts.push( parts.push(
`Docker Compose command failed with exit code ${error.exitCode}`, `Docker Compose command failed with exit code ${error.exitCode}`,
); );
} else { } else {
parts.push("Docker Compose command failed"); parts.push("Docker Compose command failed");
} }
// Add error stream output if available // Add error stream output if available
if (error.err?.trim()) { if (error.err?.trim()) {
parts.push("\nError output:"); parts.push("\nError output:");
parts.push(error.err.trim()); parts.push(error.err.trim());
} }
// Add standard output if available and different from error output // Add standard output if available and different from error output
if (error.out?.trim() && error.out !== error.err) { if (error.out?.trim() && error.out !== error.err) {
parts.push("\nStandard output:"); parts.push("\nStandard output:");
parts.push(error.out.trim()); parts.push(error.out.trim());
} }
return new Error(parts.join("\n")); return new Error(parts.join("\n"));
} }
// Handle string errors // Handle string errors
if (typeof error === "string") { if (typeof error === "string") {
return new Error(error); return new Error(error);
} }
// Fallback for unknown error types // Fallback for unknown error types
return new Error(JSON.stringify(error)); return new Error(JSON.stringify(error));
} }
/** /**
* Type guard to check if an object is a docker-compose result * Type guard to check if an object is a docker-compose result
*/ */
private isDockerComposeResult(error: unknown): error is IDockerComposeResult { private isDockerComposeResult(error: unknown): error is IDockerComposeResult {
return ( return (
typeof error === "object" && typeof error === "object" &&
error !== null && error !== null &&
"exitCode" in error && "exitCode" in error &&
"err" in error && "err" in error &&
"out" in error "out" in error
); );
} }
} }

758
src/services/input.service.test.ts
View File

@ -1,25 +1,25 @@
import { describe, expect, it, beforeEach, vi } from "vitest"; import { beforeEach, describe, expect, it, vi } from "vitest";
// Mock @actions/core before importing the module under test // Mock @actions/core before importing the module under test
const getInputMock = const getInputMock =
vi.fn<(name: string, options?: { required?: boolean }) => string>(); vi.fn<(name: string, options?: { required?: boolean }) => string>();
const getMultilineInputMock = const getMultilineInputMock =
vi.fn<(name: string, options?: { required?: boolean }) => string[]>(); vi.fn<(name: string, options?: { required?: boolean }) => string[]>();
vi.doMock("@actions/core", () => ({ vi.doMock("@actions/core", () => ({
getInput: getInputMock, getInput: getInputMock,
getMultilineInput: getMultilineInputMock, getMultilineInput: getMultilineInputMock,
debug: vi.fn(), debug: vi.fn(),
info: vi.fn(), info: vi.fn(),
warning: vi.fn(), warning: vi.fn(),
})); }));
// Mock node:fs // Mock node:fs
const existsSyncMock = vi.fn<(path: string) => boolean>(); const existsSyncMock = vi.fn<(path: string) => boolean>();
vi.doMock("node:fs", () => ({ vi.doMock("node:fs", () => ({
existsSync: existsSyncMock, existsSync: existsSyncMock,
default: { existsSync: existsSyncMock }, default: { existsSync: existsSyncMock },
})); }));
// Dynamic imports after mock setup // Dynamic imports after mock setup
@ -27,373 +27,373 @@ const { InputService, InputNames } = await import("./input.service.js");
const { LogLevel } = await import("./logger.service.js"); const { LogLevel } = await import("./logger.service.js");
describe("InputService", () => { describe("InputService", () => {
let service: InstanceType<typeof InputService>; let service: InstanceType<typeof InputService>;
beforeEach(() => { beforeEach(() => {
vi.clearAllMocks(); vi.clearAllMocks();
getMultilineInputMock.mockImplementation((inputName) => { getMultilineInputMock.mockImplementation((inputName) => {
switch (inputName) { switch (inputName) {
case InputNames.ComposeFile: case InputNames.ComposeFile:
return ["file1"]; return ["file1"];
default: default:
return []; return [];
} }
}); });
getInputMock.mockReturnValue(""); getInputMock.mockReturnValue("");
service = new InputService(); service = new InputService();
}); });
describe("getInputs", () => { describe("getInputs", () => {
describe("docker-flags", () => { describe("docker-flags", () => {
it("should return given docker-flags input", () => { it("should return given docker-flags input", () => {
getInputMock.mockImplementation((inputName) => { getInputMock.mockImplementation((inputName) => {
switch (inputName) { switch (inputName) {
case InputNames.DockerFlags: case InputNames.DockerFlags:
return "docker-flag1 docker-flag2"; return "docker-flag1 docker-flag2";
default: default:
return ""; return "";
} }
}); });
existsSyncMock.mockReturnValue(true); existsSyncMock.mockReturnValue(true);
const inputs = service.getInputs(); const inputs = service.getInputs();
expect(inputs.dockerFlags).toEqual(["docker-flag1", "docker-flag2"]); expect(inputs.dockerFlags).toEqual(["docker-flag1", "docker-flag2"]);
}); });
it("should return empty array when no docker-flags input", () => { it("should return empty array when no docker-flags input", () => {
getInputMock.mockReturnValue(""); getInputMock.mockReturnValue("");
existsSyncMock.mockReturnValue(true); existsSyncMock.mockReturnValue(true);
const inputs = service.getInputs(); const inputs = service.getInputs();
expect(inputs.dockerFlags).toEqual([]); expect(inputs.dockerFlags).toEqual([]);
}); });
}); });
describe("composeFiles", () => { describe("composeFiles", () => {
it("should return given composeFiles input", () => { it("should return given composeFiles input", () => {
getMultilineInputMock.mockImplementation((inputName) => { getMultilineInputMock.mockImplementation((inputName) => {
switch (inputName) { switch (inputName) {
case InputNames.ComposeFile: case InputNames.ComposeFile:
return ["file1", "file2"]; return ["file1", "file2"];
default: default:
return []; return [];
} }
}); });
getInputMock.mockReturnValue(""); getInputMock.mockReturnValue("");
existsSyncMock.mockReturnValue(true); existsSyncMock.mockReturnValue(true);
const inputs = service.getInputs(); const inputs = service.getInputs();
expect(inputs.composeFiles).toEqual(["file1", "file2"]); expect(inputs.composeFiles).toEqual(["file1", "file2"]);
}); });
it("should ignore empty compose file entries", () => { it("should ignore empty compose file entries", () => {
getMultilineInputMock.mockImplementation((inputName) => { getMultilineInputMock.mockImplementation((inputName) => {
switch (inputName) { switch (inputName) {
case InputNames.ComposeFile: case InputNames.ComposeFile:
return [" ", "file1"]; return [" ", "file1"];
default: default:
return []; return [];
} }
}); });
getInputMock.mockReturnValue(""); getInputMock.mockReturnValue("");
existsSyncMock.mockReturnValue(true); existsSyncMock.mockReturnValue(true);
const inputs = service.getInputs(); const inputs = service.getInputs();
expect(inputs.composeFiles).toEqual(["file1"]); expect(inputs.composeFiles).toEqual(["file1"]);
}); });
it("should accept compose file when it exists at the original path", () => { it("should accept compose file when it exists at the original path", () => {
getMultilineInputMock.mockImplementation((inputName) => { getMultilineInputMock.mockImplementation((inputName) => {
switch (inputName) { switch (inputName) {
case InputNames.ComposeFile: case InputNames.ComposeFile:
return ["./compose.yml"]; return ["./compose.yml"];
default: default:
return []; return [];
} }
}); });
getInputMock.mockImplementation((inputName) => { getInputMock.mockImplementation((inputName) => {
switch (inputName) { switch (inputName) {
case InputNames.Cwd: case InputNames.Cwd:
return "/current/working/directory"; return "/current/working/directory";
default: default:
return ""; return "";
} }
}); });
existsSyncMock.mockImplementation((file) => file === "./compose.yml"); existsSyncMock.mockImplementation((file) => file === "./compose.yml");
const inputs = service.getInputs(); const inputs = service.getInputs();
expect(inputs.composeFiles).toEqual(["./compose.yml"]); expect(inputs.composeFiles).toEqual(["./compose.yml"]);
}); });
it("should accept OCI compose files without checking the file system", () => { it("should accept OCI compose files without checking the file system", () => {
getMultilineInputMock.mockImplementation((inputName) => { getMultilineInputMock.mockImplementation((inputName) => {
switch (inputName) { switch (inputName) {
case InputNames.ComposeFile: case InputNames.ComposeFile:
return ["oci://docker.io/hoverkraft/compose-app:latest"]; return ["oci://docker.io/hoverkraft/compose-app:latest"];
default: default:
return []; return [];
} }
}); });
getInputMock.mockImplementation((inputName) => { getInputMock.mockImplementation((inputName) => {
switch (inputName) { switch (inputName) {
case InputNames.Cwd: case InputNames.Cwd:
return "/current/working/directory"; return "/current/working/directory";
default: default:
return ""; return "";
} }
}); });
const inputs = service.getInputs(); const inputs = service.getInputs();
expect(inputs.composeFiles).toEqual([ expect(inputs.composeFiles).toEqual([
"oci://docker.io/hoverkraft/compose-app:latest", "oci://docker.io/hoverkraft/compose-app:latest",
]); ]);
expect(existsSyncMock).not.toHaveBeenCalled(); expect(existsSyncMock).not.toHaveBeenCalled();
}); });
it("should throws an error when a compose file does not exist", () => { it("should throws an error when a compose file does not exist", () => {
getMultilineInputMock.mockImplementation((inputName) => { getMultilineInputMock.mockImplementation((inputName) => {
switch (inputName) { switch (inputName) {
case InputNames.ComposeFile: case InputNames.ComposeFile:
return ["file1", "file2"]; return ["file1", "file2"];
default: default:
return []; return [];
} }
}); });
getInputMock.mockImplementation((inputName) => { getInputMock.mockImplementation((inputName) => {
switch (inputName) { switch (inputName) {
case InputNames.Cwd: case InputNames.Cwd:
return "/current/working/directory"; return "/current/working/directory";
default: default:
return ""; return "";
} }
}); });
existsSyncMock.mockImplementation( existsSyncMock.mockImplementation(
(file) => file === "/current/working/directory/file1", (file) => file === "/current/working/directory/file1",
); );
expect(() => service.getInputs()).toThrow( expect(() => service.getInputs()).toThrow(
'Compose file not found in "/current/working/directory/file2", "file2"', 'Compose file not found in "/current/working/directory/file2", "file2"',
); );
}); });
it("should throws an error when no composeFiles input", () => { it("should throws an error when no composeFiles input", () => {
getMultilineInputMock.mockReturnValue([]); getMultilineInputMock.mockReturnValue([]);
getInputMock.mockReturnValue(""); getInputMock.mockReturnValue("");
expect(() => service.getInputs()).toThrow("No compose files found"); expect(() => service.getInputs()).toThrow("No compose files found");
}); });
}); });
describe("services", () => { describe("services", () => {
it("should return given services input", () => { it("should return given services input", () => {
getMultilineInputMock.mockImplementation((inputName) => { getMultilineInputMock.mockImplementation((inputName) => {
switch (inputName) { switch (inputName) {
case InputNames.Services: case InputNames.Services:
return ["service1", "service2"]; return ["service1", "service2"];
case InputNames.ComposeFile: case InputNames.ComposeFile:
return ["file1"]; return ["file1"];
default: default:
return []; return [];
} }
}); });
getInputMock.mockReturnValue(""); getInputMock.mockReturnValue("");
existsSyncMock.mockReturnValue(true); existsSyncMock.mockReturnValue(true);
const inputs = service.getInputs(); const inputs = service.getInputs();
expect(inputs.services).toEqual(["service1", "service2"]); expect(inputs.services).toEqual(["service1", "service2"]);
}); });
}); });
describe("compose-flags", () => { describe("compose-flags", () => {
it("should return given compose-flags input", () => { it("should return given compose-flags input", () => {
getInputMock.mockImplementation((inputName) => { getInputMock.mockImplementation((inputName) => {
switch (inputName) { switch (inputName) {
case InputNames.ComposeFlags: case InputNames.ComposeFlags:
return "compose-flag1 compose-flag2"; return "compose-flag1 compose-flag2";
default: default:
return ""; return "";
} }
}); });
existsSyncMock.mockReturnValue(true); existsSyncMock.mockReturnValue(true);
const inputs = service.getInputs(); const inputs = service.getInputs();
expect(inputs.composeFlags).toEqual(["compose-flag1", "compose-flag2"]); expect(inputs.composeFlags).toEqual(["compose-flag1", "compose-flag2"]);
}); });
it("should return empty array when no compose-flags input", () => { it("should return empty array when no compose-flags input", () => {
getInputMock.mockReturnValue(""); getInputMock.mockReturnValue("");
existsSyncMock.mockReturnValue(true); existsSyncMock.mockReturnValue(true);
const inputs = service.getInputs(); const inputs = service.getInputs();
expect(inputs.composeFlags).toEqual([]); expect(inputs.composeFlags).toEqual([]);
}); });
}); });
describe("up-flags", () => { describe("up-flags", () => {
it("should return given up-flags input", () => { it("should return given up-flags input", () => {
getInputMock.mockImplementation((inputName) => { getInputMock.mockImplementation((inputName) => {
switch (inputName) { switch (inputName) {
case InputNames.UpFlags: case InputNames.UpFlags:
return "up-flag1 up-flag2"; return "up-flag1 up-flag2";
default: default:
return ""; return "";
} }
}); });
existsSyncMock.mockReturnValue(true); existsSyncMock.mockReturnValue(true);
const inputs = service.getInputs(); const inputs = service.getInputs();
expect(inputs.upFlags).toEqual(["up-flag1", "up-flag2"]); expect(inputs.upFlags).toEqual(["up-flag1", "up-flag2"]);
}); });
it("should return empty array when no up-flags input", () => { it("should return empty array when no up-flags input", () => {
getInputMock.mockReturnValue(""); getInputMock.mockReturnValue("");
existsSyncMock.mockReturnValue(true); existsSyncMock.mockReturnValue(true);
const inputs = service.getInputs(); const inputs = service.getInputs();
expect(inputs.upFlags).toEqual([]); expect(inputs.upFlags).toEqual([]);
}); });
}); });
describe("down-flags", () => { describe("down-flags", () => {
it("should return given down-flags input", () => { it("should return given down-flags input", () => {
getInputMock.mockImplementation((inputName) => { getInputMock.mockImplementation((inputName) => {
switch (inputName) { switch (inputName) {
case InputNames.DownFlags: case InputNames.DownFlags:
return "down-flag1 down-flag2"; return "down-flag1 down-flag2";
default: default:
return ""; return "";
} }
}); });
existsSyncMock.mockReturnValue(true); existsSyncMock.mockReturnValue(true);
const inputs = service.getInputs(); const inputs = service.getInputs();
expect(inputs.downFlags).toEqual(["down-flag1", "down-flag2"]); expect(inputs.downFlags).toEqual(["down-flag1", "down-flag2"]);
}); });
it("should return empty array when no down-flags input", () => { it("should return empty array when no down-flags input", () => {
getInputMock.mockReturnValue(""); getInputMock.mockReturnValue("");
existsSyncMock.mockReturnValue(true); existsSyncMock.mockReturnValue(true);
const inputs = service.getInputs(); const inputs = service.getInputs();
expect(inputs.downFlags).toEqual([]); expect(inputs.downFlags).toEqual([]);
}); });
}); });
describe("cwd", () => { describe("cwd", () => {
it("should return given cwd input", () => { it("should return given cwd input", () => {
getInputMock.mockImplementation((inputName) => { getInputMock.mockImplementation((inputName) => {
switch (inputName) { switch (inputName) {
case InputNames.Cwd: case InputNames.Cwd:
return "cwd"; return "cwd";
default: default:
return ""; return "";
} }
}); });
existsSyncMock.mockReturnValue(true); existsSyncMock.mockReturnValue(true);
const inputs = service.getInputs(); const inputs = service.getInputs();
expect(inputs.cwd).toEqual("cwd"); expect(inputs.cwd).toEqual("cwd");
}); });
}); });
describe("compose-version", () => { describe("compose-version", () => {
it("should return given compose-version input", () => { it("should return given compose-version input", () => {
getInputMock.mockImplementation((inputName) => { getInputMock.mockImplementation((inputName) => {
switch (inputName) { switch (inputName) {
case InputNames.ComposeVersion: case InputNames.ComposeVersion:
return "compose-version"; return "compose-version";
default: default:
return ""; return "";
} }
}); });
existsSyncMock.mockReturnValue(true); existsSyncMock.mockReturnValue(true);
const inputs = service.getInputs(); const inputs = service.getInputs();
expect(inputs.composeVersion).toEqual("compose-version"); expect(inputs.composeVersion).toEqual("compose-version");
}); });
}); });
describe("services-log-level", () => { describe("services-log-level", () => {
it("should return given services-log-level input", () => { it("should return given services-log-level input", () => {
getInputMock.mockImplementation((inputName) => { getInputMock.mockImplementation((inputName) => {
switch (inputName) { switch (inputName) {
case InputNames.ServiceLogLevel: case InputNames.ServiceLogLevel:
return "info"; return "info";
default: default:
return ""; return "";
} }
}); });
existsSyncMock.mockReturnValue(true); existsSyncMock.mockReturnValue(true);
const inputs = service.getInputs(); const inputs = service.getInputs();
expect(inputs.serviceLogLevel).toEqual(LogLevel.Info); expect(inputs.serviceLogLevel).toEqual(LogLevel.Info);
}); });
it("should return default services-log-level input", () => { it("should return default services-log-level input", () => {
getInputMock.mockImplementation((inputName) => { getInputMock.mockImplementation((inputName) => {
switch (inputName) { switch (inputName) {
case InputNames.ServiceLogLevel: case InputNames.ServiceLogLevel:
return ""; return "";
default: default:
return ""; return "";
} }
}); });
existsSyncMock.mockReturnValue(true); existsSyncMock.mockReturnValue(true);
const inputs = service.getInputs(); const inputs = service.getInputs();
expect(inputs.serviceLogLevel).toEqual(LogLevel.Debug); expect(inputs.serviceLogLevel).toEqual(LogLevel.Debug);
}); });
it("should throw an error when services-log-level input is invalid", () => { it("should throw an error when services-log-level input is invalid", () => {
getInputMock.mockImplementation((inputName) => { getInputMock.mockImplementation((inputName) => {
switch (inputName) { switch (inputName) {
case InputNames.ServiceLogLevel: case InputNames.ServiceLogLevel:
return "invalid-log-level"; return "invalid-log-level";
default: default:
return ""; return "";
} }
}); });
existsSyncMock.mockReturnValue(true); existsSyncMock.mockReturnValue(true);
expect(() => service.getInputs()).toThrow( expect(() => service.getInputs()).toThrow(
'Invalid service log level "invalid-log-level". Valid values are: debug, info', 'Invalid service log level "invalid-log-level". Valid values are: debug, info',
); );
}); });
}); });
}); });
}); });

228
src/services/input.service.ts
View File

@ -1,147 +1,147 @@
import { getInput, getMultilineInput } from "@actions/core";
import { existsSync } from "node:fs"; import { existsSync } from "node:fs";
import { join } from "node:path"; import { join } from "node:path";
import { getInput, getMultilineInput } from "@actions/core";
import { LogLevel } from "./logger.service.js"; import { LogLevel } from "./logger.service.js";
export type Inputs = { export type Inputs = {
dockerFlags: string[]; dockerFlags: string[];
composeFiles: string[]; composeFiles: string[];
services: string[]; services: string[];
composeFlags: string[]; composeFlags: string[];
upFlags: string[]; upFlags: string[];
downFlags: string[]; downFlags: string[];
cwd: string; cwd: string;
composeVersion: string | null; composeVersion: string | null;
githubToken: string | null; githubToken: string | null;
serviceLogLevel: LogLevel; serviceLogLevel: LogLevel;
}; };
export enum InputNames { export enum InputNames {
DockerFlags = "docker-flags", DockerFlags = "docker-flags",
ComposeFile = "compose-file", ComposeFile = "compose-file",
Services = "services", Services = "services",
ComposeFlags = "compose-flags", ComposeFlags = "compose-flags",
UpFlags = "up-flags", UpFlags = "up-flags",
DownFlags = "down-flags", DownFlags = "down-flags",
Cwd = "cwd", Cwd = "cwd",
ComposeVersion = "compose-version", ComposeVersion = "compose-version",
GithubToken = "github-token", GithubToken = "github-token",
ServiceLogLevel = "services-log-level", ServiceLogLevel = "services-log-level",
} }
export const COMPOSE_VERSION_LATEST = "latest"; export const COMPOSE_VERSION_LATEST = "latest";
export class InputService { export class InputService {
getInputs(): Inputs { getInputs(): Inputs {
return { return {
dockerFlags: this.getDockerFlags(), dockerFlags: this.getDockerFlags(),
composeFiles: this.getComposeFiles(), composeFiles: this.getComposeFiles(),
services: this.getServices(), services: this.getServices(),
composeFlags: this.getComposeFlags(), composeFlags: this.getComposeFlags(),
upFlags: this.getUpFlags(), upFlags: this.getUpFlags(),
downFlags: this.getDownFlags(), downFlags: this.getDownFlags(),
cwd: this.getCwd(), cwd: this.getCwd(),
composeVersion: this.getComposeVersion(), composeVersion: this.getComposeVersion(),
githubToken: this.getGithubToken(), githubToken: this.getGithubToken(),
serviceLogLevel: this.getServiceLogLevel(), serviceLogLevel: this.getServiceLogLevel(),
}; };
} }
private getDockerFlags(): string[] { private getDockerFlags(): string[] {
return this.parseFlags(getInput(InputNames.DockerFlags)); return this.parseFlags(getInput(InputNames.DockerFlags));
} }
private getComposeFiles(): string[] { private getComposeFiles(): string[] {
const cwd = this.getCwd(); const cwd = this.getCwd();
const composeFiles = getMultilineInput(InputNames.ComposeFile).filter( const composeFiles = getMultilineInput(InputNames.ComposeFile).filter(
(composeFile: string) => { (composeFile: string) => {
const trimmedComposeFile = composeFile.trim(); const trimmedComposeFile = composeFile.trim();
if (!trimmedComposeFile.length) { if (!trimmedComposeFile.length) {
return false; return false;
} }
if (trimmedComposeFile.startsWith("oci://")) { if (trimmedComposeFile.startsWith("oci://")) {
return true; return true;
} }
const possiblePaths = [join(cwd, composeFile), composeFile]; const possiblePaths = [join(cwd, composeFile), composeFile];
for (const path of possiblePaths) { for (const path of possiblePaths) {
if (existsSync(path)) { if (existsSync(path)) {
return true; return true;
} }
} }
throw new Error( throw new Error(
`Compose file not found in "${possiblePaths.join('", "')}"`, `Compose file not found in "${possiblePaths.join('", "')}"`,
); );
}, },
); );
if (!composeFiles.length) { if (!composeFiles.length) {
throw new Error("No compose files found"); throw new Error("No compose files found");
} }
return composeFiles; return composeFiles;
} }
private getServices(): string[] { private getServices(): string[] {
return getMultilineInput(InputNames.Services, { required: false }); return getMultilineInput(InputNames.Services, { required: false });
} }
private getComposeFlags(): string[] { private getComposeFlags(): string[] {
return this.parseFlags(getInput(InputNames.ComposeFlags)); return this.parseFlags(getInput(InputNames.ComposeFlags));
} }
private getUpFlags(): string[] { private getUpFlags(): string[] {
return this.parseFlags(getInput(InputNames.UpFlags)); return this.parseFlags(getInput(InputNames.UpFlags));
} }
private getDownFlags(): string[] { private getDownFlags(): string[] {
return this.parseFlags(getInput(InputNames.DownFlags)); return this.parseFlags(getInput(InputNames.DownFlags));
} }
private parseFlags(flags: string | null): string[] { private parseFlags(flags: string | null): string[] {
if (!flags) { if (!flags) {
return []; return [];
} }
return flags.trim().split(" "); return flags.trim().split(" ");
} }
private getCwd(): string { private getCwd(): string {
return getInput(InputNames.Cwd); return getInput(InputNames.Cwd);
} }
private getComposeVersion(): string | null { private getComposeVersion(): string | null {
return ( return (
getInput(InputNames.ComposeVersion, { getInput(InputNames.ComposeVersion, {
required: false, required: false,
}) || null }) || null
); );
} }
private getGithubToken(): string | null { private getGithubToken(): string | null {
return ( return (
getInput(InputNames.GithubToken, { getInput(InputNames.GithubToken, {
required: false, required: false,
}) || null }) || null
); );
} }
private getServiceLogLevel(): LogLevel { private getServiceLogLevel(): LogLevel {
const configuredLevel = getInput(InputNames.ServiceLogLevel, { const configuredLevel = getInput(InputNames.ServiceLogLevel, {
required: false, required: false,
}); });
if ( if (
configuredLevel && configuredLevel &&
!Object.values(LogLevel).includes(configuredLevel as LogLevel) !Object.values(LogLevel).includes(configuredLevel as LogLevel)
) { ) {
throw new Error( throw new Error(
`Invalid service log level "${configuredLevel}". Valid values are: ${Object.values(LogLevel).join(", ")}`, `Invalid service log level "${configuredLevel}". Valid values are: ${Object.values(LogLevel).join(", ")}`,
); );
} }
return (configuredLevel as LogLevel) || LogLevel.Debug; return (configuredLevel as LogLevel) || LogLevel.Debug;
} }
} }

2
src/services/installer-adapter/docker-compose-installer-adapter.ts
View File

@ -1,3 +1,3 @@
export interface DockerComposeInstallerAdapter { export interface DockerComposeInstallerAdapter {
install(version: string): Promise<void>; install(version: string): Promise<void>;
} }

318
src/services/installer-adapter/manual-installer-adapter.test.ts
View File

@ -1,221 +1,221 @@
import { describe, expect, it, beforeEach, vi } from "vitest";
import type { ExecOptions } from "@actions/exec";
import type { OutgoingHttpHeaders } from "node:http"; import type { OutgoingHttpHeaders } from "node:http";
import type { ExecOptions } from "@actions/exec";
import { beforeEach, describe, expect, it, vi } from "vitest";
// Mock @actions/exec // Mock @actions/exec
const execMock = const execMock =
vi.fn< vi.fn<
(command: string, args?: string[], options?: ExecOptions) => Promise<number> (command: string, args?: string[], options?: ExecOptions) => Promise<number>
>(); >();
vi.doMock("@actions/exec", () => ({ vi.doMock("@actions/exec", () => ({
exec: execMock, exec: execMock,
})); }));
// Mock @actions/io // Mock @actions/io
const mkdirPMock = vi.fn<(fsPath: string) => Promise<void>>(); const mkdirPMock = vi.fn<(fsPath: string) => Promise<void>>();
vi.doMock("@actions/io", () => ({ vi.doMock("@actions/io", () => ({
mkdirP: mkdirPMock, mkdirP: mkdirPMock,
})); }));
// Mock @actions/tool-cache // Mock @actions/tool-cache
const cacheFileMock = const cacheFileMock =
vi.fn< vi.fn<
( (
sourceFile: string, sourceFile: string,
targetFile: string, targetFile: string,
tool: string, tool: string,
version: string, version: string,
arch?: string, arch?: string,
) => Promise<string> ) => Promise<string>
>(); >();
const downloadToolMock = const downloadToolMock =
vi.fn< vi.fn<
( (
url: string, url: string,
dest?: string, dest?: string,
auth?: string, auth?: string,
headers?: OutgoingHttpHeaders, headers?: OutgoingHttpHeaders,
) => Promise<string> ) => Promise<string>
>(); >();
vi.doMock("@actions/tool-cache", () => ({ vi.doMock("@actions/tool-cache", () => ({
cacheFile: cacheFileMock, cacheFile: cacheFileMock,
downloadTool: downloadToolMock, downloadTool: downloadToolMock,
})); }));
// Dynamic import after mock setup // Dynamic import after mock setup
const { ManualInstallerAdapter } = await import( const { ManualInstallerAdapter } = await import(
"./manual-installer-adapter.js" "./manual-installer-adapter.js"
); );
const originalHome = process.env.HOME; const originalHome = process.env.HOME;
const originalDockerConfig = process.env.DOCKER_CONFIG; const originalDockerConfig = process.env.DOCKER_CONFIG;
describe("ManualInstallerAdapter", () => { describe("ManualInstallerAdapter", () => {
let adapter: InstanceType<typeof ManualInstallerAdapter>; let adapter: InstanceType<typeof ManualInstallerAdapter>;
beforeEach(() => { beforeEach(() => {
vi.resetAllMocks(); vi.resetAllMocks();
if (originalHome === undefined) { if (originalHome === undefined) {
delete process.env.HOME; delete process.env.HOME;
} else { } else {
process.env.HOME = originalHome; process.env.HOME = originalHome;
} }
if (originalDockerConfig === undefined) { if (originalDockerConfig === undefined) {
delete process.env.DOCKER_CONFIG; delete process.env.DOCKER_CONFIG;
} else { } else {
process.env.DOCKER_CONFIG = originalDockerConfig; process.env.DOCKER_CONFIG = originalDockerConfig;
} }
adapter = new ManualInstallerAdapter(); adapter = new ManualInstallerAdapter();
}); });
describe("install", () => { describe("install", () => {
it("should install docker compose correctly", async () => { it("should install docker compose correctly", async () => {
// Arrange // Arrange
const version = "v2.29.0"; const version = "v2.29.0";
execMock.mockImplementationOnce(async (_command, _args, options) => { execMock.mockImplementationOnce(async (_command, _args, options) => {
options?.listeners?.stdout?.(Buffer.from("Linux\n")); options?.listeners?.stdout?.(Buffer.from("Linux\n"));
return 0; return 0;
}); });
execMock.mockImplementationOnce(async (_command, _args, options) => { execMock.mockImplementationOnce(async (_command, _args, options) => {
options?.listeners?.stdout?.(Buffer.from("x86_64\n")); options?.listeners?.stdout?.(Buffer.from("x86_64\n"));
return 0; return 0;
}); });
process.env.HOME = "/home/test"; process.env.HOME = "/home/test";
// Act // Act
await adapter.install(version); await adapter.install(version);
// Assert // Assert
expect(mkdirPMock).toHaveBeenCalledWith("docker-compose"); expect(mkdirPMock).toHaveBeenCalledWith("docker-compose");
expect(execMock).toHaveBeenNthCalledWith(1, "uname -s", [], { expect(execMock).toHaveBeenNthCalledWith(1, "uname -s", [], {
listeners: { stdout: expect.any(Function) }, listeners: { stdout: expect.any(Function) },
}); });
expect(execMock).toHaveBeenNthCalledWith(2, "uname -m", [], { expect(execMock).toHaveBeenNthCalledWith(2, "uname -m", [], {
listeners: { stdout: expect.any(Function) }, listeners: { stdout: expect.any(Function) },
}); });
expect(downloadToolMock).toHaveBeenCalledWith( expect(downloadToolMock).toHaveBeenCalledWith(
"https://github.com/docker/compose/releases/download/v2.29.0/docker-compose-Linux-x86_64", "https://github.com/docker/compose/releases/download/v2.29.0/docker-compose-Linux-x86_64",
"/home/test/.docker/cli-plugins/docker-compose", "/home/test/.docker/cli-plugins/docker-compose",
); );
expect(cacheFileMock).toHaveBeenCalledWith( expect(cacheFileMock).toHaveBeenCalledWith(
"/home/test/.docker/cli-plugins/docker-compose", "/home/test/.docker/cli-plugins/docker-compose",
"docker-compose", "docker-compose",
"docker-compose", "docker-compose",
version, version,
); );
}); });
it("should use DOCKER_CONFIG when set", async () => { it("should use DOCKER_CONFIG when set", async () => {
// Arrange // Arrange
const version = "v2.29.0"; const version = "v2.29.0";
execMock.mockImplementationOnce(async (_command, _args, options) => { execMock.mockImplementationOnce(async (_command, _args, options) => {
options?.listeners?.stdout?.(Buffer.from("Linux\n")); options?.listeners?.stdout?.(Buffer.from("Linux\n"));
return 0; return 0;
}); });
execMock.mockImplementationOnce(async (_command, _args, options) => { execMock.mockImplementationOnce(async (_command, _args, options) => {
options?.listeners?.stdout?.(Buffer.from("x86_64\n")); options?.listeners?.stdout?.(Buffer.from("x86_64\n"));
return 0; return 0;
}); });
process.env.DOCKER_CONFIG = "/custom/docker"; process.env.DOCKER_CONFIG = "/custom/docker";
// Act // Act
await adapter.install(version); await adapter.install(version);
// Assert // Assert
expect(downloadToolMock).toHaveBeenCalledWith( expect(downloadToolMock).toHaveBeenCalledWith(
"https://github.com/docker/compose/releases/download/v2.29.0/docker-compose-Linux-x86_64", "https://github.com/docker/compose/releases/download/v2.29.0/docker-compose-Linux-x86_64",
"/custom/docker/cli-plugins/docker-compose", "/custom/docker/cli-plugins/docker-compose",
); );
}); });
it("should handle version without 'v' prefix", async () => { it("should handle version without 'v' prefix", async () => {
// Arrange // Arrange
const version = "2.29.0"; const version = "2.29.0";
execMock.mockImplementationOnce(async (_command, _args, options) => { execMock.mockImplementationOnce(async (_command, _args, options) => {
options?.listeners?.stdout?.(Buffer.from("Linux\n")); options?.listeners?.stdout?.(Buffer.from("Linux\n"));
return 0; return 0;
}); });
execMock.mockImplementationOnce(async (_command, _args, options) => { execMock.mockImplementationOnce(async (_command, _args, options) => {
options?.listeners?.stdout?.(Buffer.from("x86_64\n")); options?.listeners?.stdout?.(Buffer.from("x86_64\n"));
return 0; return 0;
}); });
process.env.HOME = "/home/test"; process.env.HOME = "/home/test";
// Act // Act
await adapter.install(version); await adapter.install(version);
// Assert // Assert
expect(mkdirPMock).toHaveBeenCalledWith("docker-compose"); expect(mkdirPMock).toHaveBeenCalledWith("docker-compose");
expect(execMock).toHaveBeenNthCalledWith(1, "uname -s", [], { expect(execMock).toHaveBeenNthCalledWith(1, "uname -s", [], {
listeners: { stdout: expect.any(Function) }, listeners: { stdout: expect.any(Function) },
}); });
expect(execMock).toHaveBeenNthCalledWith(2, "uname -m", [], { expect(execMock).toHaveBeenNthCalledWith(2, "uname -m", [], {
listeners: { stdout: expect.any(Function) }, listeners: { stdout: expect.any(Function) },
}); });
expect(downloadToolMock).toHaveBeenCalledWith( expect(downloadToolMock).toHaveBeenCalledWith(
"https://github.com/docker/compose/releases/download/v2.29.0/docker-compose-Linux-x86_64", "https://github.com/docker/compose/releases/download/v2.29.0/docker-compose-Linux-x86_64",
"/home/test/.docker/cli-plugins/docker-compose", "/home/test/.docker/cli-plugins/docker-compose",
); );
}); });
it("should not add 'v' prefix for 1.x versions", async () => { it("should not add 'v' prefix for 1.x versions", async () => {
// Arrange // Arrange
const version = "1.29.0"; const version = "1.29.0";
execMock.mockImplementationOnce(async (_command, _args, options) => { execMock.mockImplementationOnce(async (_command, _args, options) => {
options?.listeners?.stdout?.(Buffer.from("Linux\n")); options?.listeners?.stdout?.(Buffer.from("Linux\n"));
return 0; return 0;
}); });
execMock.mockImplementationOnce(async (_command, _args, options) => { execMock.mockImplementationOnce(async (_command, _args, options) => {
options?.listeners?.stdout?.(Buffer.from("x86_64\n")); options?.listeners?.stdout?.(Buffer.from("x86_64\n"));
return 0; return 0;
}); });
delete process.env.DOCKER_CONFIG; delete process.env.DOCKER_CONFIG;
process.env.HOME = "/home/test"; process.env.HOME = "/home/test";
// Act // Act
await adapter.install(version); await adapter.install(version);
// Assert // Assert
expect(downloadToolMock).toHaveBeenCalledWith( expect(downloadToolMock).toHaveBeenCalledWith(
"https://github.com/docker/compose/releases/download/1.29.0/docker-compose-Linux-x86_64", "https://github.com/docker/compose/releases/download/1.29.0/docker-compose-Linux-x86_64",
"/home/test/.docker/cli-plugins/docker-compose", "/home/test/.docker/cli-plugins/docker-compose",
); );
}); });
it("should throw an error if a command fails", async () => { it("should throw an error if a command fails", async () => {
// Arrange // Arrange
const version = "v2.29.0"; const version = "v2.29.0";
// Uname -s // Uname -s
execMock.mockResolvedValueOnce(1); execMock.mockResolvedValueOnce(1);
// Act // Act
await expect(adapter.install(version)).rejects.toThrow( await expect(adapter.install(version)).rejects.toThrow(
"Failed to run command: uname -s", "Failed to run command: uname -s",
); );
// Assert // Assert
expect(execMock).toHaveBeenNthCalledWith(1, "uname -s", [], { expect(execMock).toHaveBeenNthCalledWith(1, "uname -s", [], {
listeners: { stdout: expect.any(Function) }, listeners: { stdout: expect.any(Function) },
}); });
}); });
}); });
}); });

104
src/services/installer-adapter/manual-installer-adapter.ts
View File

@ -1,69 +1,69 @@
import { basename } from "node:path";
import { exec } from "@actions/exec"; import { exec } from "@actions/exec";
import { mkdirP } from "@actions/io"; import { mkdirP } from "@actions/io";
import { basename } from "node:path";
import { cacheFile, downloadTool } from "@actions/tool-cache"; import { cacheFile, downloadTool } from "@actions/tool-cache";
import type { DockerComposeInstallerAdapter } from "./docker-compose-installer-adapter.js"; import type { DockerComposeInstallerAdapter } from "./docker-compose-installer-adapter.js";
export class ManualInstallerAdapter implements DockerComposeInstallerAdapter { export class ManualInstallerAdapter implements DockerComposeInstallerAdapter {
async install(version: string): Promise<void> { async install(version: string): Promise<void> {
const dockerComposePluginPath = await this.getDockerComposePluginPath(); const dockerComposePluginPath = await this.getDockerComposePluginPath();
// Create the directory if it doesn't exist // Create the directory if it doesn't exist
await mkdirP(basename(dockerComposePluginPath)); await mkdirP(basename(dockerComposePluginPath));
await this.downloadFile(version, dockerComposePluginPath); await this.downloadFile(version, dockerComposePluginPath);
await exec(`chmod +x ${dockerComposePluginPath}`); await exec(`chmod +x ${dockerComposePluginPath}`);
await cacheFile( await cacheFile(
dockerComposePluginPath, dockerComposePluginPath,
"docker-compose", "docker-compose",
"docker-compose", "docker-compose",
version, version,
); );
} }
private async getDockerComposePluginPath(): Promise<string> { private async getDockerComposePluginPath(): Promise<string> {
const dockerConfig = const dockerConfig =
process.env.DOCKER_CONFIG || `${process.env.HOME}/.docker`; process.env.DOCKER_CONFIG || `${process.env.HOME}/.docker`;
const dockerComposePluginPath = `${dockerConfig}/cli-plugins/docker-compose`; const dockerComposePluginPath = `${dockerConfig}/cli-plugins/docker-compose`;
return dockerComposePluginPath; return dockerComposePluginPath;
} }
private async downloadFile( private async downloadFile(
version: string, version: string,
installerPath: string, installerPath: string,
): Promise<void> { ): Promise<void> {
if (!version.startsWith("v") && parseInt(version.split(".")[0], 10) >= 2) { if (!version.startsWith("v") && parseInt(version.split(".")[0], 10) >= 2) {
version = `v${version}`; version = `v${version}`;
} }
const system = await this.getSystem(); const system = await this.getSystem();
const hardware = await this.getHardware(); const hardware = await this.getHardware();
const url = `https://github.com/docker/compose/releases/download/${version}/docker-compose-${system}-${hardware}`; const url = `https://github.com/docker/compose/releases/download/${version}/docker-compose-${system}-${hardware}`;
await downloadTool(url, installerPath); await downloadTool(url, installerPath);
} }
private async getSystem(): Promise<string> { private async getSystem(): Promise<string> {
return this.runCommand("uname -s"); return this.runCommand("uname -s");
} }
private async getHardware(): Promise<string> { private async getHardware(): Promise<string> {
return this.runCommand("uname -m"); return this.runCommand("uname -m");
} }
private async runCommand(command: string): Promise<string> { private async runCommand(command: string): Promise<string> {
let output = ""; let output = "";
const result = await exec(command, [], { const result = await exec(command, [], {
listeners: { listeners: {
stdout: (data: Buffer) => { stdout: (data: Buffer) => {
output += data.toString(); output += data.toString();
}, },
}, },
}); });
if (result !== 0) { if (result !== 0) {
throw new Error(`Failed to run command: ${command}`); throw new Error(`Failed to run command: ${command}`);
} }
return output.trim(); return output.trim();
} }
} }

88
src/services/logger.service.test.ts
View File

@ -1,4 +1,4 @@
import { describe, expect, it, beforeEach, vi } from "vitest"; import { beforeEach, describe, expect, it, vi } from "vitest";
// Import types directly from the module // Import types directly from the module
import type { LogLevel as LogLevelType } from "./logger.service.js"; import type { LogLevel as LogLevelType } from "./logger.service.js";
@ -9,60 +9,60 @@ const infoMock = vi.fn();
const debugMock = vi.fn(); const debugMock = vi.fn();
vi.doMock("@actions/core", () => ({ vi.doMock("@actions/core", () => ({
warning: warningMock, warning: warningMock,
info: infoMock, info: infoMock,
debug: debugMock, debug: debugMock,
})); }));
// Dynamic import after mock setup // Dynamic import after mock setup
const { LoggerService, LogLevel } = await import("./logger.service.js"); const { LoggerService, LogLevel } = await import("./logger.service.js");
describe("LoggerService", () => { describe("LoggerService", () => {
let loggerService: InstanceType<typeof LoggerService>; let loggerService: InstanceType<typeof LoggerService>;
beforeEach(() => { beforeEach(() => {
vi.clearAllMocks(); vi.clearAllMocks();
loggerService = new LoggerService(); loggerService = new LoggerService();
}); });
describe("warn", () => { describe("warn", () => {
it("should call warning with the correct message", () => { it("should call warning with the correct message", () => {
const message = "This is a warning message"; const message = "This is a warning message";
loggerService.warn(message); loggerService.warn(message);
expect(warningMock).toHaveBeenCalledWith(message); expect(warningMock).toHaveBeenCalledWith(message);
}); });
}); });
describe("info", () => { describe("info", () => {
it("should call info with the correct message", () => { it("should call info with the correct message", () => {
const message = "This is an info message"; const message = "This is an info message";
loggerService.info(message); loggerService.info(message);
expect(infoMock).toHaveBeenCalledWith(message); expect(infoMock).toHaveBeenCalledWith(message);
}); });
}); });
describe("debug", () => { describe("debug", () => {
it("should call debug with the correct message", () => { it("should call debug with the correct message", () => {
const message = "This is a debug message"; const message = "This is a debug message";
loggerService.debug(message); loggerService.debug(message);
expect(debugMock).toHaveBeenCalledWith(message); expect(debugMock).toHaveBeenCalledWith(message);
}); });
}); });
describe("getServiceLogger", () => { describe("getServiceLogger", () => {
it("should return the correct logger function for debug level", () => { it("should return the correct logger function for debug level", () => {
const logger = loggerService.getServiceLogger(LogLevel.Debug); const logger = loggerService.getServiceLogger(LogLevel.Debug);
expect(logger).toBe(loggerService.debug); expect(logger).toBe(loggerService.debug);
}); });
it("should return the correct logger function for info level", () => { it("should return the correct logger function for info level", () => {
const logger = loggerService.getServiceLogger(LogLevel.Info); const logger = loggerService.getServiceLogger(LogLevel.Info);
expect(logger).toBe(loggerService.info); expect(logger).toBe(loggerService.info);
}); });
it("should default to info level if an unknown level is provided", () => { it("should default to info level if an unknown level is provided", () => {
const logger = loggerService.getServiceLogger("unknown" as LogLevelType); const logger = loggerService.getServiceLogger("unknown" as LogLevelType);
expect(logger).toBe(loggerService.info); expect(logger).toBe(loggerService.info);
}); });
}); });
}); });

42
src/services/logger.service.ts
View File

@ -1,31 +1,31 @@
import { debug, info, warning } from "@actions/core"; import { debug, info, warning } from "@actions/core";
export class LoggerService { export class LoggerService {
warn(message: string): void { warn(message: string): void {
warning(message); warning(message);
} }
info(message: string): void { info(message: string): void {
info(message); info(message);
} }
debug(message: string) { debug(message: string) {
debug(message); debug(message);
} }
getServiceLogger(level: LogLevel): (message: string) => void { getServiceLogger(level: LogLevel): (message: string) => void {
switch (level) { switch (level) {
case LogLevel.Debug: case LogLevel.Debug:
return this.debug; return this.debug;
case LogLevel.Info: case LogLevel.Info:
return this.info; return this.info;
default: default:
return this.info; return this.info;
} }
} }
} }
export enum LogLevel { export enum LogLevel {
Debug = "debug", Debug = "debug",
Info = "info", Info = "info",
} }

37
tsconfig.json
View File

@ -1,21 +1,20 @@
{ {
"$schema": "https://json.schemastore.org/tsconfig", "$schema": "https://json.schemastore.org/tsconfig",
"compilerOptions": { "compilerOptions": {
"target": "ES2024", "target": "ES2024",
"module": "NodeNext", "module": "NodeNext",
"rootDir": "./src", "rootDir": "./src",
"moduleResolution": "NodeNext", "moduleResolution": "NodeNext",
"baseUrl": "./", "sourceMap": true,
"sourceMap": true, "outDir": "./dist",
"outDir": "./dist", "noImplicitAny": true,
"noImplicitAny": true, "esModuleInterop": true,
"esModuleInterop": true, "forceConsistentCasingInFileNames": true,
"forceConsistentCasingInFileNames": true, "strict": true,
"strict": true, "skipLibCheck": true,
"skipLibCheck": true, "newLine": "lf",
"newLine": "lf", "noEmit": true
"noEmit": true },
}, "exclude": ["./dist", "./node_modules", "./src/**/*.test.ts", "./coverage"],
"exclude": ["./dist", "./node_modules", "./src/**/*.test.ts", "./coverage"], "include": ["./src/**/*"]
"include": ["./src/**/*"]
} }

16
vitest.config.ts
View File

@ -1,12 +1,12 @@
import { defineConfig } from "vitest/config"; import { defineConfig } from "vitest/config";
export default defineConfig({ export default defineConfig({
test: { test: {
coverage: { coverage: {
include: ["src/**/*.{ts,tsx,js,jsx}"], include: ["src/**/*.{ts,tsx,js,jsx}"],
provider: "v8", provider: "v8",
}, },
environment: "node", environment: "node",
globals: true, globals: true,
}, },
}); });