diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 1592254eb27f373fc74f79cd4df2e67b064a50fa..a5322dd13132c688dbdecb1f9aee199d359de840 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,74 +1,291 @@ variables: - BIN_FOLDER: /binary + GIT_SUBMODULE_STRATEGY: recursive + GIT_SUBMODULE_FORCE_HTTPS: "true" + SECURE_FILES_DOWNLOAD_PATH: './' + BIN_NAME: dojo -.macOS-sign_and_pkg: + MACOS_PKG_EXTENSION: '.pkg' + MACOS_PKG_BIN_NAME: "${BIN_NAME}${MACOS_PKG_EXTENSION}" + + ARTIFACTS_FOLDER: /artifacts + + BIN_FOLDER_MACOS: $ARTIFACTS_FOLDER/macOS + BIN_FOLDER_LINUX: $ARTIFACTS_FOLDER/Linux + BIN_FOLDER_WINDOWS: $ARTIFACTS_FOLDER/Windows + + BIN_FOLDER_MACOS_ARM64: $BIN_FOLDER_MACOS/arm64 + BIN_FOLDER_MACOS_X64: $BIN_FOLDER_MACOS/x64 + + BIN_FILE_MACOS_ARM64: $BIN_FOLDER_MACOS_ARM64/$BIN_NAME + BIN_FILE_MACOS_X64: $BIN_FOLDER_MACOS_X64/$BIN_NAME + BIN_PKG_FILE_MACOS_ARM64: $BIN_FOLDER_MACOS_ARM64/$MACOS_PKG_BIN_NAME + BIN_PKG_FILE_MACOS_X64: $BIN_FOLDER_MACOS_X64/$MACOS_PKG_BIN_NAME + BIN_FILE_LINUX_ARM64: $BIN_FOLDER_LINUX/arm64/$BIN_NAME + BIN_FILE_LINUX_X64: $BIN_FOLDER_LINUX/x64/$BIN_NAME + BIN_FILE_WINDOWS_ARM64: $BIN_FOLDER_WINDOWS/arm64/$BIN_NAME.exe + BIN_FILE_WINDOWS_X64: $BIN_FOLDER_WINDOWS/x64/$BIN_NAME.exe + + VERSION_FILE: $ARTIFACTS_FOLDER/VERSION + VERSION_DEV_SUFFIX: '-dev' + + PROJECT_FOLDER: NodeApp + + PACKAGE_REGISTRY_URL: "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/generic/${BIN_NAME}" + + +.get_version: + script: + - IS_DEV=$([[ $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH ]] && echo false || echo true) + - VERSION=$(jq -r .version $PROJECT_FOLDER/package.json)$([[ $IS_DEV == true ]] && echo $VERSION_DEV_SUFFIX || echo '') + +.get_packages_url: + script: + - PACKAGE_URL_MACOS_ARM64_BIN="${PACKAGE_REGISTRY_URL}_macOS-arm64/${VERSION}/${BIN_NAME}" + - PACKAGE_URL_MACOS_X64_BIN="${PACKAGE_REGISTRY_URL}_macOS-x64/${VERSION}/${BIN_NAME}" + - PACKAGE_URL_MACOS_ARM64_PKG="${PACKAGE_REGISTRY_URL}_macOS-pkg-arm64/${VERSION}/${MACOS_PKG_BIN_NAME}" + - PACKAGE_URL_MACOS_X64_PKG="${PACKAGE_REGISTRY_URL}_macOS-pkg-x64/${VERSION}/${MACOS_PKG_BIN_NAME}" + - PACKAGE_URL_LINUX_ARM64_BIN="${PACKAGE_REGISTRY_URL}_Linux-arm64/${VERSION}/${BIN_NAME}" + - PACKAGE_URL_LINUX_X64_BIN="${PACKAGE_REGISTRY_URL}_Linux-x64/${VERSION}/${BIN_NAME}" + - PACKAGE_URL_WINDOWS_ARM64_BIN="${PACKAGE_REGISTRY_URL}_Windows-arm64/${VERSION}/${BIN_NAME}" + - PACKAGE_URL_WINDOWS_X64_BIN="${PACKAGE_REGISTRY_URL}_Windows-x64/${VERSION}/${BIN_NAME}" + +.build_cli: + script: + - cd NodeApp + # Download secure files + - curl --silent "https://gitlab.com/gitlab-org/incubation-engineering/mobile-devops/download-secure-files/-/raw/main/installer" | bash + - mv env_$VERSION .env + # Install dependencies + - npm install + - npm run build + # Build binaries + ## macOS + - npx pkg . -t node18-macos-arm64 --output $BIN_FILE_MACOS_ARM64 --no-bytecode --public-packages "*" --public + - npx pkg . -t node18-macos-x64 --output $BIN_FILE_MACOS_X64 --no-bytecode --public-packages "*" --public + ## Linux + - npx pkg . -t node18-linuxstatic-arm64 --output $BIN_FILE_LINUX_ARM64 --no-bytecode --public-packages "*" --public + - npx pkg . -t node18-linuxstatic-x64 --output $BIN_FILE_LINUX_X64 --no-bytecode --public-packages "*" --public + ## Windows + - npx pkg . -t node18-win-arm64 --output $BIN_FILE_WINDOWS_ARM64 --no-bytecode --public-packages "*" --public + - npx pkg . -t node18-win-x64 --output $BIN_FILE_WINDOWS_X64 --no-bytecode --public-packages "*" --public + +.sign_macos: script: # Sign excecutable - - codesign --force --options=runtime --entitlements ../../../Resources/macApp/Signing/entitlements.plist --sign $SIGN_DEV_ID_APP --keychain $SIGN_LOGIN_KEYCHAIN_PATH --timestamp ${BIN_NAME} + - codesign --force --options=runtime --entitlements ../../../Resources/macApp/Signing/entitlements.plist --sign $SIGN_DEV_ID_APP --keychain $SIGN_LOGIN_KEYCHAIN_PATH --timestamp ${BIN_NAME} # Package and notarize the app - xcrun notarytool store-credentials --apple-id $SIGN_APPLE_ID --team-id $SIGN_TEAM_ID --password $SIGN_APP_PASSWORD --keychain $SIGN_LOGIN_KEYCHAIN_PATH $SIGN_KEYCHAIN_PROFILE - ditto ${BIN_NAME} ${BIN_NAME}_pkg/usr/local/bin/ - - productbuild --identifier $SIGN_IDENTIFIER --version $APP_VERSION --sign $SIGN_DEV_ID_INST --keychain $SIGN_LOGIN_KEYCHAIN_PATH --timestamp --root ${BIN_NAME}_pkg / ${BIN_NAME}.pkg + - productbuild --identifier $SIGN_IDENTIFIER --version $VERSION --sign $SIGN_DEV_ID_INST --keychain $SIGN_LOGIN_KEYCHAIN_PATH --timestamp --root ${BIN_NAME}_pkg / ${MACOS_PKG_BIN_NAME} - xcrun notarytool submit ${BIN_NAME}.pkg --keychain $SIGN_LOGIN_KEYCHAIN_PATH --keychain-profile $SIGN_KEYCHAIN_PROFILE --wait - xcrun stapler staple ${BIN_NAME}.pkg #Clean folder - rm -Rf ${BIN_NAME}_pkg +.clean_release: + script: + # Delete release if it already exists + - 'curl --request DELETE --header "JOB-TOKEN: $CI_JOB_TOKEN" "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/releases/${VERSION}"' -image: node:latest +.clean_packages: + script: + # Get all packages of the project + - 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages" > gitlabPackages.json' + # Filter and select packages to delete (based on version) + - packagesToDelete=`jq -r '.[] | select(.version=="'${VERSION}'") | ._links.delete_api_path' gitlabPackages.json` + # Delete packages by calling Gitlab API + - > + for deletePath in $packagesToDelete; do + echo "Deleting package at path : ${deletePath}" + curl --request DELETE --header "JOB-TOKEN: $CI_JOB_TOKEN" "${deletePath}" + done -cache: - paths: - - NodeApp/node_modules/ stages: - - Build_stage - - Sign_stage + - build + - sign + - clean-same-release + - clean-dev-release + - upload + - release + -build: - stage: Build_stage +build:test: + stage: build tags: - build - variables: - GIT_SUBMODULE_STRATEGY: recursive - GIT_SUBMODULE_FORCE_HTTPS: "true" - SECURE_FILES_DOWNLOAD_PATH: './' + image: node:latest script: - - cd NodeApp - # Download secure files - - curl --silent "https://gitlab.com/gitlab-org/incubation-engineering/mobile-devops/download-secure-files/-/raw/main/installer" | bash - - mv env .env - # Install dependencies - - npm install - - npm run build - # Build binaries - - npx pkg . -t node18-macos-arm64 --output $BIN_FOLDER/macOS/arm64/$BIN_NAME --no-bytecode --public-packages "*" --public - - npx pkg . -t node18-macos-x64 --output $BIN_FOLDER/macOS/x64/$BIN_NAME --no-bytecode --public-packages "*" --public - - npx pkg . -t node18-linuxstatic-arm64 --output $BIN_FOLDER/linux/arm64/$BIN_NAME --no-bytecode --public-packages "*" --public - - npx pkg . -t node18-linuxstatic-x64 --output $BIN_FOLDER/linux/x64/$BIN_NAME --no-bytecode --public-packages "*" --public - - npx pkg . -t node18-win-arm64 --output $BIN_FOLDER/Windows/arm64/$BIN_NAME --no-bytecode --public-packages "*" --public - - npx pkg . -t node18-win-x64 --output $BIN_FOLDER/Windows/x64/$BIN_NAME --no-bytecode --public-packages "*" --public + - apt update + - apt install -y jq + - !reference [.get_version, script] + - !reference [.build_cli, script] + rules: + - if: '$CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH && $CI_COMMIT_BRANCH !~ /^v[0-9]+(\.[0-9]+)*$/' + +build:version: + stage: build + tags: + - build + image: node:latest + script: + - apt update + - apt install -y jq + - !reference [.get_version, script] + - mkdir -p $ARTIFACTS_FOLDER + - echo $VERSION > $VERSION_FILE + - !reference [.build_cli, script] artifacts: untracked: true paths: - - $BIN_FOLDER/* + - $ARTIFACTS_FOLDER/* expire_in: 1 hour + rules: + - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH || $CI_COMMIT_BRANCH =~ /^v[0-9]+(\.[0-9]+)*$/' -sign_macos: - stage: Sign_stage +sign:macos: + stage: sign tags: - macos_signing dependencies: - - build - script: + - build:version + script: + - VERSION=$(cat $VERSION_FILE) - security unlock-keychain -p $SIGN_KEYCHAIN_PASSWORD $SIGN_LOGIN_KEYCHAIN_PATH - - cd $BIN_FOLDER/macOS/arm64 - - !reference [.macOS-sign_and_pkg, script] - - cd $BIN_FOLDER/macOS/x64 - - !reference [.macOS-sign_and_pkg, script] + - cd $BIN_FOLDER_MACOS_ARM64 + - !reference [.sign_macos, script] + - cd $BIN_FOLDER_MACOS_X64 + - !reference [.sign_macos, script] artifacts: paths: - - $BIN_FOLDER/* - expire_in: 1 week + - $ARTIFACTS_FOLDER/* + expire_in: 1 day + rules: + - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH || $CI_COMMIT_BRANCH =~ /^v[0-9]+(\.[0-9]+)*$/' + +clean:release: + stage: clean-same-release + tags: + - gitlab_clean + image: registry.gitlab.com/gitlab-ci-utils/curl-jq:latest + script: + - !reference [.get_version, script] + - !reference [.clean_release, script] + rules: + - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH || $CI_COMMIT_BRANCH =~ /^v[0-9]+(\.[0-9]+)*$/' + +clean:packages: + stage: clean-same-release + tags: + - gitlab_clean + image: registry.gitlab.com/gitlab-ci-utils/curl-jq:latest + script: + - !reference [.get_version, script] + - !reference [.clean_packages, script] + rules: + - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH || $CI_COMMIT_BRANCH =~ /^v[0-9]+(\.[0-9]+)*$/' + +clean-dev:release: + stage: clean-dev-release + tags: + - gitlab_clean + image: registry.gitlab.com/gitlab-ci-utils/curl-jq:latest + script: + - !reference [.get_version, script] + - VERSION="${VERSION}${VERSION_DEV_SUFFIX}" + - !reference [.clean_release, script] + rules: + - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH' + +clean-dev:packages: + stage: clean-dev-release + tags: + - gitlab_clean + image: registry.gitlab.com/gitlab-ci-utils/curl-jq:latest + script: + - !reference [.get_version, script] + - VERSION="${VERSION}${VERSION_DEV_SUFFIX}" + - !reference [.clean_packages, script] + rules: + - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH' +upload:packages: + stage: upload + tags: + - gitlab_package + dependencies: + - sign:macos + image: registry.gitlab.com/gitlab-ci-utils/curl-jq:latest + script: + - !reference [.get_version, script] + - !reference [.get_packages_url, script] + #macOS + - 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file ${BIN_FILE_MACOS_ARM64} "${PACKAGE_URL_MACOS_ARM64_BIN}";' + - 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file ${BIN_FILE_MACOS_X64} "${PACKAGE_URL_MACOS_X64_BIN}";' + - 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file ${BIN_PKG_FILE_MACOS_ARM64} "${PACKAGE_URL_MACOS_ARM64_PKG}";' + - 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file ${BIN_PKG_FILE_MACOS_X64} "${PACKAGE_URL_MACOS_X64_PKG}";' + #Linux + - 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file ${BIN_FILE_LINUX_ARM64} "${PACKAGE_URL_LINUX_ARM64_BIN}";' + - 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file ${BIN_FILE_LINUX_X64} "${PACKAGE_URL_LINUX_X64_BIN}";' + #Windows + - 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file ${BIN_FILE_WINDOWS_ARM64} "${PACKAGE_URL_WINDOWS_ARM64_BIN}";' + - 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file ${BIN_FILE_WINDOWS_X64} "${PACKAGE_URL_WINDOWS_X64_BIN}";' + rules: + - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH || $CI_COMMIT_BRANCH =~ /^v[0-9]+(\.[0-9]+)*$/' + +release_job: + stage: release + tags: + - release + image: registry.gitlab.com/gitlab-ci-utils/curl-jq:latest + script: + - !reference [.get_version, script] + - !reference [.get_packages_url, script] + - echo 'Running release_job' + - CHANGELOG_LINE_START=`awk '/##\ [0-9]+\.[0-9]+\.[0-9]+/{print NR; exit;}' CHANGELOG.md` + - CHANGELOG_LINE_END=`awk '/##\ [0-9]+\.[0-9]+\.[0-9]+/{ count++; if(count>1) {print NR; exit;}}' CHANGELOG.md` + - DESCRIPTION=`awk 'NR > '$CHANGELOG_LINE_START' && NR < '$CHANGELOG_LINE_END'' CHANGELOG.md` + - > + RELEASE_DATA=$(jq --null-input --arg version "$VERSION" --arg description "# Changelog (version $VERSION) $DESCRIPTION" --arg tag_name "$VERSION" --arg ref "$CI_COMMIT_SHORT_SHA" '{ + "name": $version, + "description": $description, + "tag_name": $tag_name, + "ref": $ref, + "assets": { + "links": [ + { + "name": "Windows (ARM64) binary", + "url": "'${PACKAGE_URL_WINDOWS_ARM64_BIN}'", + },{ + "name": "Windows (x64) binary", + "url": "'${PACKAGE_URL_WINDOWS_X64_BIN}'", + },{ + "name": "Linux (ARM64) binary", + "url": "'${PACKAGE_URL_LINUX_ARM64_BIN}'", + },{ + "name": "Linux (x64) binary", + "url": "'${PACKAGE_URL_LINUX_X64_BIN}'", + },{ + "name": "macOS (Intel) binary", + "url": "'${PACKAGE_URL_MACOS_X64_BIN}'", + },{ + "name": "macOS (Apple Silicon) binary", + "url": "'${PACKAGE_URL_MACOS_ARM64_BIN}'", + },{ + "name": "macOS (Intel) package", + "url": "'${PACKAGE_URL_MACOS_X64_PKG}'", + },{ + "name": "macOS (Apple Silicon) package", + "url": "'${PACKAGE_URL_MACOS_ARM64_PKG}'", + } + ] + } + }') + - > + curl --data "${RELEASE_DATA}" \ + --header "Content-Type: application/json" \ + --header "JOB-TOKEN: $CI_JOB_TOKEN" \ + --request POST "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/releases" + rules: + - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH || $CI_COMMIT_BRANCH =~ /^v[0-9]+(\.[0-9]+)*$/' \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000000000000000000000000000000000000..619aa96399baa4168efc9ee2bc236f249f2664d1 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,35 @@ +# Changelog + +<!-- +### ✨ Feature +### 🤏 Minor change +### 🎨 Interface +### 🐛 Bugfix +### 🔒 Security +### 🚀️ CI / CD +### 🔨 Internal / Developers +### 📚 Documentation + +**💥 Breaking:** +**⚠️ Deprecation:** +--> + +## 2.0.0 (?) + +### ✨ Feature +- Added license: AGPLv3 + +### 🎨 Interface +- **💥 Breaking:** Renamed `enonce` to `assignment` +- **💥 Breaking:** Renamed `exercice` to `exercise` + +### 🔨 Internal / Developers +- Auto release by pipeline + - For vX.Y.Z branch create release and tag with `-dev` suffix + - For main branch create definitive release and remove `-dev` releases + + +## 1.0.1 (2023-08-12) + +### ✨ Feature +- 🎉 Initial release of the project \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000000000000000000000000000000000..f7d198bb4afb60b8b4827662e1d1d7bc8870385a --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + DojoCLI + Copyright (C) 2023 ISC / projects / Dojo / Projects / UI + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see <https://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +<https://www.gnu.org/licenses/>. diff --git a/NodeApp/.idea/jetbrainsConfiguration b/NodeApp/.idea/jetbrainsConfiguration index 57997f6ff4ad2d2e23e03f86d997f64463cc898d..4d703a2dd39ec0c2b71bbbbda8900588c4e360bd 160000 --- a/NodeApp/.idea/jetbrainsConfiguration +++ b/NodeApp/.idea/jetbrainsConfiguration @@ -1 +1 @@ -Subproject commit 57997f6ff4ad2d2e23e03f86d997f64463cc898d +Subproject commit 4d703a2dd39ec0c2b71bbbbda8900588c4e360bd diff --git a/NodeApp/package.json b/NodeApp/package.json index 6b739f9a73f9fa85704ee94fb47211aba031fb38..eb095058924ef551b7734599bd77cf4621dca7de 100644 --- a/NodeApp/package.json +++ b/NodeApp/package.json @@ -1,6 +1,6 @@ { "name" : "dojo_cli", - "version" : "1.0.1", + "version" : "2.0.0", "main" : "dist/app.js", "bin" : { "dojo": "./dist/app.js" diff --git a/NodeApp/src/commander/CommanderApp.ts b/NodeApp/src/commander/CommanderApp.ts index b374d7013d4f1bdf2ab73db0011dc03f12d134ba..a6002b0a382a5b6d9f54f5825dfa21b7235f7549 100644 --- a/NodeApp/src/commander/CommanderApp.ts +++ b/NodeApp/src/commander/CommanderApp.ts @@ -1,8 +1,8 @@ import { Command } from 'commander'; -import EnonceCommand from './enonce/EnonceCommand'; import SessionCommand from './session/SessionCommand'; -import ExerciceCommand from './exercice/ExerciceCommand'; import ClientsSharedConfig from '../sharedByClients/config/ClientsSharedConfig'; +import AssignmentCommand from './assignment/AssignmentCommand'; +import ExerciseCommand from './exercise/ExerciseCommand'; class CommanderApp { @@ -12,7 +12,7 @@ class CommanderApp { this.program .name('dojo') .description('CLI of the Dojo application') - .version('1.0.1') + .version('2.0.0') .showHelpAfterError() .configureHelp({ showGlobalOptions: true, @@ -32,8 +32,8 @@ class CommanderApp { private registerCommands() { SessionCommand.registerOnCommand(this.program); - EnonceCommand.registerOnCommand(this.program); - ExerciceCommand.registerOnCommand(this.program); + AssignmentCommand.registerOnCommand(this.program); + ExerciseCommand.registerOnCommand(this.program); } } diff --git a/NodeApp/src/commander/assignment/AssignmentCommand.ts b/NodeApp/src/commander/assignment/AssignmentCommand.ts new file mode 100644 index 0000000000000000000000000000000000000000..c629ddc14f3ed6785ac5a4b5c7a9fe05b82ef23b --- /dev/null +++ b/NodeApp/src/commander/assignment/AssignmentCommand.ts @@ -0,0 +1,25 @@ +import CommanderCommand from '../CommanderCommand'; +import AssignmentCreateCommand from './AssignmentCreateCommand'; +import AssignmentPublishCommand from './AssignmentPublishCommand'; +import AssignmentUnpublishCommand from './AssignmentUnpublishCommand'; + + +class AssignmentCommand extends CommanderCommand { + protected commandName: string = 'assignment'; + + protected defineCommand() { + this.command + .description('manage an assignment'); + } + + protected defineSubCommands() { + AssignmentCreateCommand.registerOnCommand(this.command); + AssignmentPublishCommand.registerOnCommand(this.command); + AssignmentUnpublishCommand.registerOnCommand(this.command); + } + + protected async commandAction(options: any): Promise<void> { } +} + + +export default new AssignmentCommand(); \ No newline at end of file diff --git a/NodeApp/src/commander/enonce/EnonceCreateCommand.ts b/NodeApp/src/commander/assignment/AssignmentCreateCommand.ts similarity index 65% rename from NodeApp/src/commander/enonce/EnonceCreateCommand.ts rename to NodeApp/src/commander/assignment/AssignmentCreateCommand.ts index 6002d25561cf4194631c146bba7849a10cb7f9cf..c2b384afaf2f8c41e52c0cf836d537912df28ed1 100644 --- a/NodeApp/src/commander/enonce/EnonceCreateCommand.ts +++ b/NodeApp/src/commander/assignment/AssignmentCreateCommand.ts @@ -4,18 +4,18 @@ import ora from 'ora'; import GitlabManager from '../../managers/GitlabManager'; import GitlabUser from '../../shared/types/Gitlab/GitlabUser'; import DojoBackendManager from '../../managers/DojoBackendManager'; -import Enonce from '../../sharedByClients/models/Enonce'; import Toolbox from '../../shared/helpers/Toolbox'; import AccessesHelper from '../../helpers/AccessesHelper'; +import Assignment from '../../sharedByClients/models/Assignment'; -class EnonceCreateCommand extends CommanderCommand { +class AssignmentCreateCommand extends CommanderCommand { protected commandName: string = 'create'; protected defineCommand() { this.command - .description('create a new repository for an enonce') - .requiredOption('-n, --name <name>', 'name of the enonce') + .description('create a new repository for an assignment') + .requiredOption('-n, --name <name>', 'name of the assignment') .option('-i, --members_id <ids...>', 'list of gitlab members ids (teaching staff) to add to the repository') .option('-u, --members_username <usernames...>', 'list of gitlab members username (teaching staff) to add to the repository') .option('-t, --template <string>', 'id or url of the template (http/s and ssh urls are possible)') @@ -39,12 +39,12 @@ class EnonceCreateCommand extends CommanderCommand { return; } - const enonceGetSpinner: ora.Ora = ora('Checking enonce name availability').start(); - if ( await DojoBackendManager.getEnonce(options.name) ) { - enonceGetSpinner.fail(`Enonce name "${ options.name }" is already taken. Please choose another one.`); + const assignmentGetSpinner: ora.Ora = ora('Checking assignment name availability').start(); + if ( await DojoBackendManager.getAssignment(options.name) ) { + assignmentGetSpinner.fail(`Assignment name "${ options.name }" is already taken. Please choose another one.`); return; } - enonceGetSpinner.succeed(`Enonce name "${ options.name }" is available`); + assignmentGetSpinner.succeed(`Assignment name "${ options.name }" is available`); if ( options.template ) { templateIdOrNamespace = options.template; @@ -59,12 +59,12 @@ class EnonceCreateCommand extends CommanderCommand { } } - // Create the enonce + // Create the assignment { - console.log(chalk.cyan('Please wait while we are creating the enonce...')); + console.log(chalk.cyan('Please wait while we are creating the assignment...')); try { - const enonce: Enonce = await DojoBackendManager.createEnonce(options.name, members, templateIdOrNamespace); + const assignment: Assignment = await DojoBackendManager.createAssignment(options.name, members, templateIdOrNamespace); const oraInfo = (message: string) => { ora({ @@ -73,10 +73,10 @@ class EnonceCreateCommand extends CommanderCommand { }).start().info(); }; - oraInfo(`${ chalk.magenta('Name:') } ${ enonce.name }`); - oraInfo(`${ chalk.magenta('Web URL:') } ${ enonce.gitlabCreationInfo.web_url }`); - oraInfo(`${ chalk.magenta('HTTP Repo:') } ${ enonce.gitlabCreationInfo.http_url_to_repo }`); - oraInfo(`${ chalk.magenta('SSH Repo:') } ${ enonce.gitlabCreationInfo.ssh_url_to_repo }`); + oraInfo(`${ chalk.magenta('Name:') } ${ assignment.name }`); + oraInfo(`${ chalk.magenta('Web URL:') } ${ assignment.gitlabCreationInfo.web_url }`); + oraInfo(`${ chalk.magenta('HTTP Repo:') } ${ assignment.gitlabCreationInfo.http_url_to_repo }`); + oraInfo(`${ chalk.magenta('SSH Repo:') } ${ assignment.gitlabCreationInfo.ssh_url_to_repo }`); } catch ( error ) { return; } @@ -85,4 +85,4 @@ class EnonceCreateCommand extends CommanderCommand { } -export default new EnonceCreateCommand(); \ No newline at end of file +export default new AssignmentCreateCommand(); \ No newline at end of file diff --git a/NodeApp/src/commander/assignment/AssignmentPublishCommand.ts b/NodeApp/src/commander/assignment/AssignmentPublishCommand.ts new file mode 100644 index 0000000000000000000000000000000000000000..6816aa312932ce01df561c2c1cab1a3f366a1a77 --- /dev/null +++ b/NodeApp/src/commander/assignment/AssignmentPublishCommand.ts @@ -0,0 +1,10 @@ +import AssignmentPublishUnpublishCommandBase from './AssignmentPublishUnpublishCommandBase'; + + +class AssignmentPublishCommand extends AssignmentPublishUnpublishCommandBase { + protected commandName: string = 'publish'; + protected publish: boolean = true; +} + + +export default new AssignmentPublishCommand(); \ No newline at end of file diff --git a/NodeApp/src/commander/assignment/AssignmentPublishUnpublishCommandBase.ts b/NodeApp/src/commander/assignment/AssignmentPublishUnpublishCommandBase.ts new file mode 100644 index 0000000000000000000000000000000000000000..b5df0c9b02e54abd46fbc438e7005e868f17a551 --- /dev/null +++ b/NodeApp/src/commander/assignment/AssignmentPublishUnpublishCommandBase.ts @@ -0,0 +1,83 @@ +import CommanderCommand from '../CommanderCommand'; +import inquirer from 'inquirer'; +import chalk from 'chalk'; +import SessionManager from '../../managers/SessionManager'; +import ora from 'ora'; +import DojoBackendManager from '../../managers/DojoBackendManager'; +import Assignment from '../../sharedByClients/models/Assignment'; + + +abstract class AssignmentPublishUnpublishCommandBase extends CommanderCommand { + protected abstract publish: boolean; + + protected defineCommand() { + this.command + .description('publish an assignment') + .argument('<name or url>', 'name or url (http/s or ssh) of the assignment') + .option('-f, --force', 'don\'t ask for confirmation') + .action(this.commandAction.bind(this)); + } + + protected async commandAction(assignmentNameOrUrl: string, options: { force: boolean }): Promise<void> { + if ( !options.force ) { + options.force = (await inquirer.prompt({ + type : 'confirm', + name : 'force', + message: this.publish ? 'Are you sure you want to publish this assignment?' : 'Are you sure you want to unpublish this assignment?' + })).force; + } + + if ( !options.force ) { + return; + } + + let assignment!: Assignment | undefined; + + { + console.log(chalk.cyan('Please wait while we verify and retrieve data...')); + + if ( !await SessionManager.testSession(true, null) ) { + return; + } + + ora('Checking assignment:').start().info(); + ora({ + text : assignmentNameOrUrl, + indent: 4 + }).start().info(); + const assignmentGetSpinner: ora.Ora = ora({ + text : 'Checking if assignment exists', + indent: 8 + }).start(); + assignment = await DojoBackendManager.getAssignment(assignmentNameOrUrl); + if ( !assignment ) { + assignmentGetSpinner.fail(`The assignment doesn't exists`); + return; + } + assignmentGetSpinner.succeed(`The assignment exists`); + + const assignmentCheckAccessSpinner: ora.Ora = ora({ + text : 'Checking accesses', + indent: 8 + }).start(); + if ( !assignment.staff ) { + assignmentCheckAccessSpinner.fail(`You are not in the staff of this assignment`); + return; + } + assignmentCheckAccessSpinner.succeed(`You are in the staff of this assignment`); + } + + { + console.log(chalk.cyan(`Please wait while we ${ this.publish ? 'publish' : 'unpublish' } the assignment...`)); + + try { + await DojoBackendManager.changeAssignmentPublishedStatus(assignment, this.publish); + } catch ( error ) { + return; + } + } + } +} + + +export default AssignmentPublishUnpublishCommandBase; \ No newline at end of file diff --git a/NodeApp/src/commander/assignment/AssignmentUnpublishCommand.ts b/NodeApp/src/commander/assignment/AssignmentUnpublishCommand.ts new file mode 100644 index 0000000000000000000000000000000000000000..e329c48dc0cd673b8e730f65939cea71a0859057 --- /dev/null +++ b/NodeApp/src/commander/assignment/AssignmentUnpublishCommand.ts @@ -0,0 +1,10 @@ +import AssignmentPublishUnpublishCommandBase from './AssignmentPublishUnpublishCommandBase'; + + +class AssignmentUnpublishCommand extends AssignmentPublishUnpublishCommandBase { + protected commandName: string = 'unpublish'; + protected publish: boolean = false; +} + + +export default new AssignmentUnpublishCommand(); \ No newline at end of file diff --git a/NodeApp/src/commander/enonce/EnonceCommand.ts b/NodeApp/src/commander/enonce/EnonceCommand.ts deleted file mode 100644 index dc3a5f3a4cf399998813aa2d1720911ef4a2ee71..0000000000000000000000000000000000000000 --- a/NodeApp/src/commander/enonce/EnonceCommand.ts +++ /dev/null @@ -1,25 +0,0 @@ -import CommanderCommand from '../CommanderCommand'; -import EnonceCreateCommand from './EnonceCreateCommand'; -import EnoncePublishCommand from './EnoncePublishCommand'; -import EnonceUnpublishCommand from './EnonceUnpublishCommand'; - - -class EnonceCommand extends CommanderCommand { - protected commandName: string = 'enonce'; - - protected defineCommand() { - this.command - .description('manage an enonce'); - } - - protected defineSubCommands() { - EnonceCreateCommand.registerOnCommand(this.command); - EnoncePublishCommand.registerOnCommand(this.command); - EnonceUnpublishCommand.registerOnCommand(this.command); - } - - protected async commandAction(options: any): Promise<void> { } -} - - -export default new EnonceCommand(); \ No newline at end of file diff --git a/NodeApp/src/commander/enonce/EnoncePublishCommand.ts b/NodeApp/src/commander/enonce/EnoncePublishCommand.ts deleted file mode 100644 index 91900f62875774f4ec254e7ad1ad001e8dc99ff3..0000000000000000000000000000000000000000 --- a/NodeApp/src/commander/enonce/EnoncePublishCommand.ts +++ /dev/null @@ -1,10 +0,0 @@ -import EnoncePublishUnpublishCommandBase from './EnoncePublishUnpublishCommandBase'; - - -class EnoncePublishCommand extends EnoncePublishUnpublishCommandBase { - protected commandName: string = 'publish'; - protected publish: boolean = true; -} - - -export default new EnoncePublishCommand(); \ No newline at end of file diff --git a/NodeApp/src/commander/enonce/EnoncePublishUnpublishCommandBase.ts b/NodeApp/src/commander/enonce/EnoncePublishUnpublishCommandBase.ts deleted file mode 100644 index c94c419d6379fa0847e5f26e1b87e18068580b0a..0000000000000000000000000000000000000000 --- a/NodeApp/src/commander/enonce/EnoncePublishUnpublishCommandBase.ts +++ /dev/null @@ -1,83 +0,0 @@ -import CommanderCommand from '../CommanderCommand'; -import inquirer from 'inquirer'; -import Enonce from '../../sharedByClients/models/Enonce'; -import chalk from 'chalk'; -import SessionManager from '../../managers/SessionManager'; -import ora from 'ora'; -import DojoBackendManager from '../../managers/DojoBackendManager'; - - -abstract class EnoncePublishUnpublishCommandBase extends CommanderCommand { - protected abstract publish: boolean; - - protected defineCommand() { - this.command - .description('publish an enonce') - .argument('<name or url>', 'name or url (http/s or ssh) of the enonce') - .option('-f, --force', 'don\'t ask for confirmation') - .action(this.commandAction.bind(this)); - } - - protected async commandAction(enonceNameOrUrl: string, options: { force: boolean }): Promise<void> { - if ( !options.force ) { - options.force = (await inquirer.prompt({ - type : 'confirm', - name : 'force', - message: this.publish ? 'Are you sure you want to publish this enonce?' : 'Are you sure you want to unpublish this enonce?' - })).force; - } - - if ( !options.force ) { - return; - } - - let enonce!: Enonce | undefined; - - { - console.log(chalk.cyan('Please wait while we verify and retrieve data...')); - - if ( !await SessionManager.testSession(true, null) ) { - return; - } - - ora('Checking enonce:').start().info(); - ora({ - text : enonceNameOrUrl, - indent: 4 - }).start().info(); - const enonceGetSpinner: ora.Ora = ora({ - text : 'Checking if enonce exists', - indent: 8 - }).start(); - enonce = await DojoBackendManager.getEnonce(enonceNameOrUrl); - if ( !enonce ) { - enonceGetSpinner.fail(`The enonce doesn't exists`); - return; - } - enonceGetSpinner.succeed(`The enonce exists`); - - const enonceCheckAccessSpinner: ora.Ora = ora({ - text : 'Checking accesses', - indent: 8 - }).start(); - if ( !enonce.staff ) { - enonceCheckAccessSpinner.fail(`You are not in the staff of this enonce`); - return; - } - enonceCheckAccessSpinner.succeed(`You are in the staff of this enonce`); - } - - { - console.log(chalk.cyan(`Please wait while we ${ this.publish ? 'publish' : 'unpublish' } the enonce...`)); - - try { - await DojoBackendManager.changeEnoncePublishedStatus(enonce, this.publish); - } catch ( error ) { - return; - } - } - } -} - - -export default EnoncePublishUnpublishCommandBase; \ No newline at end of file diff --git a/NodeApp/src/commander/enonce/EnonceUnpublishCommand.ts b/NodeApp/src/commander/enonce/EnonceUnpublishCommand.ts deleted file mode 100644 index 2a3e3d33e79ed1fa20c26e6563bab85d9e33748a..0000000000000000000000000000000000000000 --- a/NodeApp/src/commander/enonce/EnonceUnpublishCommand.ts +++ /dev/null @@ -1,10 +0,0 @@ -import EnoncePublishUnpublishCommandBase from './EnoncePublishUnpublishCommandBase'; - - -class EnonceUnpublishCommand extends EnoncePublishUnpublishCommandBase { - protected commandName: string = 'unpublish'; - protected publish: boolean = false; -} - - -export default new EnonceUnpublishCommand(); \ No newline at end of file diff --git a/NodeApp/src/commander/exercice/ExerciceCommand.ts b/NodeApp/src/commander/exercice/ExerciceCommand.ts deleted file mode 100644 index 27a734528c5ec8a2e1d9f1a6418f61eaa0be95fa..0000000000000000000000000000000000000000 --- a/NodeApp/src/commander/exercice/ExerciceCommand.ts +++ /dev/null @@ -1,23 +0,0 @@ -import CommanderCommand from '../CommanderCommand'; -import ExerciceCreateCommand from './ExerciceCreateCommand'; -import ExerciceRunCommand from './ExerciceRunCommand'; - - -class ExerciceCommand extends CommanderCommand { - protected commandName: string = 'exercice'; - - protected defineCommand() { - this.command - .description('manage an exercice'); - } - - protected defineSubCommands() { - ExerciceCreateCommand.registerOnCommand(this.command); - ExerciceRunCommand.registerOnCommand(this.command); - } - - protected async commandAction(options: any): Promise<void> { } -} - - -export default new ExerciceCommand(); \ No newline at end of file diff --git a/NodeApp/src/commander/exercice/ExerciceCreateCommand.ts b/NodeApp/src/commander/exercice/ExerciceCreateCommand.ts deleted file mode 100644 index ccd761f934eef858b8cc73aedb29eeca8b0755e6..0000000000000000000000000000000000000000 --- a/NodeApp/src/commander/exercice/ExerciceCreateCommand.ts +++ /dev/null @@ -1,91 +0,0 @@ -import CommanderCommand from '../CommanderCommand'; -import chalk from 'chalk'; -import GitlabManager from '../../managers/GitlabManager'; -import GitlabUser from '../../shared/types/Gitlab/GitlabUser'; -import Enonce from '../../sharedByClients/models/Enonce'; -import ora from 'ora'; -import DojoBackendManager from '../../managers/DojoBackendManager'; -import Exercice from '../../sharedByClients/models/Exercice'; -import AccessesHelper from '../../helpers/AccessesHelper'; - - -class ExerciceCreateCommand extends CommanderCommand { - protected commandName: string = 'create'; - - protected defineCommand() { - this.command - .description('create a new exercice from an enonce') - .requiredOption('-e, --enonce <value>', 'enonce source (Dojo enonce ID, Dojo enonce name or Gitlab enonce URL)') - .option('-i, --members_id <ids...>', 'list of gitlab members ids (group\'s student) to add to the repository') - .option('-u, --members_username <usernames...>', 'list of gitlab members username (group\'s student) to add to the repository') - .action(this.commandAction.bind(this)); - } - - protected async commandAction(options: any): Promise<void> { - let members!: Array<GitlabUser> | false; - let enonce!: Enonce | undefined; - - // Check access and retrieve data - { - console.log(chalk.cyan('Please wait while we verify and retrieve data...')); - - if ( !await AccessesHelper.checkStudent() ) { - return; - } - - members = await GitlabManager.fetchMembers(options); - if ( !members ) { - return; - } - - ora('Checking enonce:').start().info(); - const enonceGetSpinner: ora.Ora = ora({ - text : 'Checking if enonce exists', - indent: 4 - }).start(); - enonce = await DojoBackendManager.getEnonce(options.enonce); - if ( !enonce ) { - enonceGetSpinner.fail(`Enonce "${ options.enonce }" doesn't exists`); - return; - } - enonceGetSpinner.succeed(`Enonce "${ options.enonce }" exists`); - - const enoncePublishedSpinner: ora.Ora = ora({ - text : 'Checking if enonce is published', - indent: 4 - }).start(); - if ( !enonce.published ) { - enoncePublishedSpinner.fail(`Enonce "${ enonce.name }" isn't published`); - return; - } - enoncePublishedSpinner.succeed(`Enonce "${ enonce.name }" is published`); - } - - //Create the exercice - { - console.log(chalk.cyan('Please wait while we are creating the exercice...')); - - try { - const exercice: Exercice = await DojoBackendManager.createExercice((enonce as Enonce).name, members); - - const oraInfo = (message: string) => { - ora({ - text : message, - indent: 4 - }).start().info(); - }; - - oraInfo(`${ chalk.magenta('Id:') } ${ exercice.id }`); - oraInfo(`${ chalk.magenta('Name:') } ${ exercice.name }`); - oraInfo(`${ chalk.magenta('Web URL:') } ${ exercice.gitlabCreationInfo.web_url }`); - oraInfo(`${ chalk.magenta('HTTP Repo:') } ${ exercice.gitlabCreationInfo.http_url_to_repo }`); - oraInfo(`${ chalk.magenta('SSH Repo:') } ${ exercice.gitlabCreationInfo.ssh_url_to_repo }`); - } catch ( error ) { - return; - } - } - } -} - - -export default new ExerciceCreateCommand(); \ No newline at end of file diff --git a/NodeApp/src/commander/exercise/ExerciseCommand.ts b/NodeApp/src/commander/exercise/ExerciseCommand.ts new file mode 100644 index 0000000000000000000000000000000000000000..ef2c3f263f3bf1bdd287016d4d194b41ab44888d --- /dev/null +++ b/NodeApp/src/commander/exercise/ExerciseCommand.ts @@ -0,0 +1,23 @@ +import CommanderCommand from '../CommanderCommand'; +import ExerciseCreateCommand from './ExerciseCreateCommand'; +import ExerciseRunCommand from './ExerciseRunCommand'; + + +class ExerciseCommand extends CommanderCommand { + protected commandName: string = 'exercise'; + + protected defineCommand() { + this.command + .description('manage an exercise'); + } + + protected defineSubCommands() { + ExerciseCreateCommand.registerOnCommand(this.command); + ExerciseRunCommand.registerOnCommand(this.command); + } + + protected async commandAction(options: any): Promise<void> { } +} + + +export default new ExerciseCommand(); \ No newline at end of file diff --git a/NodeApp/src/commander/exercise/ExerciseCreateCommand.ts b/NodeApp/src/commander/exercise/ExerciseCreateCommand.ts new file mode 100644 index 0000000000000000000000000000000000000000..9116ff3a4c5cf8356ab05f57fd171b6eae15702b --- /dev/null +++ b/NodeApp/src/commander/exercise/ExerciseCreateCommand.ts @@ -0,0 +1,91 @@ +import CommanderCommand from '../CommanderCommand'; +import chalk from 'chalk'; +import GitlabManager from '../../managers/GitlabManager'; +import GitlabUser from '../../shared/types/Gitlab/GitlabUser'; +import ora from 'ora'; +import DojoBackendManager from '../../managers/DojoBackendManager'; +import AccessesHelper from '../../helpers/AccessesHelper'; +import Assignment from '../../sharedByClients/models/Assignment'; +import Exercise from '../../sharedByClients/models/Exercise'; + + +class ExerciseCreateCommand extends CommanderCommand { + protected commandName: string = 'create'; + + protected defineCommand() { + this.command + .description('create a new exercise from an assignment') + .requiredOption('-a, --assignment <value>', 'assignment source (Dojo assignment ID, Dojo assignment name or Gitlab assignment URL)') + .option('-i, --members_id <ids...>', 'list of gitlab members ids (group\'s student) to add to the repository') + .option('-u, --members_username <usernames...>', 'list of gitlab members username (group\'s student) to add to the repository') + .action(this.commandAction.bind(this)); + } + + protected async commandAction(options: any): Promise<void> { + let members!: Array<GitlabUser> | false; + let assignment!: Assignment | undefined; + + // Check access and retrieve data + { + console.log(chalk.cyan('Please wait while we verify and retrieve data...')); + + if ( !await AccessesHelper.checkStudent() ) { + return; + } + + members = await GitlabManager.fetchMembers(options); + if ( !members ) { + return; + } + + ora('Checking assignment:').start().info(); + const assignmentGetSpinner: ora.Ora = ora({ + text : 'Checking if assignment exists', + indent: 4 + }).start(); + assignment = await DojoBackendManager.getAssignment(options.assignment); + if ( !assignment ) { + assignmentGetSpinner.fail(`Assignment "${ options.assignment }" doesn't exists`); + return; + } + assignmentGetSpinner.succeed(`Assignment "${ options.assignment }" exists`); + + const assignmentPublishedSpinner: ora.Ora = ora({ + text : 'Checking if assignment is published', + indent: 4 + }).start(); + if ( !assignment.published ) { + assignmentPublishedSpinner.fail(`Assignment "${ assignment.name }" isn't published`); + return; + } + assignmentPublishedSpinner.succeed(`Assignment "${ assignment.name }" is published`); + } + + //Create the exercise + { + console.log(chalk.cyan('Please wait while we are creating the exercise...')); + + try { + const exercise: Exercise = await DojoBackendManager.createExercise((assignment as Assignment).name, members); + + const oraInfo = (message: string) => { + ora({ + text : message, + indent: 4 + }).start().info(); + }; + + oraInfo(`${ chalk.magenta('Id:') } ${ exercise.id }`); + oraInfo(`${ chalk.magenta('Name:') } ${ exercise.name }`); + oraInfo(`${ chalk.magenta('Web URL:') } ${ exercise.gitlabCreationInfo.web_url }`); + oraInfo(`${ chalk.magenta('HTTP Repo:') } ${ exercise.gitlabCreationInfo.http_url_to_repo }`); + oraInfo(`${ chalk.magenta('SSH Repo:') } ${ exercise.gitlabCreationInfo.ssh_url_to_repo }`); + } catch ( error ) { + return; + } + } + } +} + + +export default new ExerciseCreateCommand(); \ No newline at end of file diff --git a/NodeApp/src/commander/exercice/ExerciceRunCommand.ts b/NodeApp/src/commander/exercise/ExerciseRunCommand.ts similarity index 66% rename from NodeApp/src/commander/exercice/ExerciceRunCommand.ts rename to NodeApp/src/commander/exercise/ExerciseRunCommand.ts index 413020649e600349ddd7310ac4d4a15bad020cd8..7fdd21b620679f37d5919171a3ae6c1e5320ce33 100644 --- a/NodeApp/src/commander/exercice/ExerciceRunCommand.ts +++ b/NodeApp/src/commander/exercise/ExerciseRunCommand.ts @@ -4,29 +4,29 @@ import fs from 'node:fs'; import ora from 'ora'; import util from 'util'; import { exec } from 'child_process'; -import SharedEnonceHelper from '../../shared/helpers/Dojo/SharedEnonceHelper'; -import EnonceFile from '../../shared/types/Dojo/EnonceFile'; import chalk from 'chalk'; -import ExerciceDockerCompose from '../../sharedByClients/helpers/Dojo/ExerciceDockerCompose'; import * as os from 'os'; import path from 'path'; -import ExerciceResultsValidation from '../../sharedByClients/helpers/Dojo/ExerciceResultsValidation'; -import ExerciceCheckerError from '../../shared/types/Dojo/ExerciceCheckerError'; -import ClientsSharedExerciceHelper from '../../sharedByClients/helpers/Dojo/ClientsSharedExerciceHelper'; import ClientsSharedConfig from '../../sharedByClients/config/ClientsSharedConfig'; +import AssignmentFile from '../../shared/types/Dojo/AssignmentFile'; +import ExerciseDockerCompose from '../../sharedByClients/helpers/Dojo/ExerciseDockerCompose'; +import ExerciseResultsValidation from '../../sharedByClients/helpers/Dojo/ExerciseResultsValidation'; +import SharedAssignmentHelper from '../../shared/helpers/Dojo/SharedAssignmentHelper'; +import ExerciseCheckerError from '../../shared/types/Dojo/ExerciseCheckerError'; +import ClientsSharedExerciseHelper from '../../sharedByClients/helpers/Dojo/ClientsSharedExerciseHelper'; const execAsync = util.promisify(exec); -class ExerciceRunCommand extends CommanderCommand { +class ExerciseRunCommand extends CommanderCommand { protected commandName: string = 'run'; private readonly dateISOString: string = (new Date()).toISOString().replace(/:/g, '_').replace(/\./g, '_'); private readonly folderResultsVolume: string = path.join(os.homedir(), 'DojoExecutions', `dojo_execLogs_${ this.dateISOString }`); private readonly folderResultsDojo: string = path.join(this.folderResultsVolume, `Dojo/`); - private readonly folderResultsExercice: string = path.join(this.folderResultsVolume, `Exercice/`); + private readonly folderResultsExercise: string = path.join(this.folderResultsVolume, `Exercise/`); private readonly projectName: string = `${ ClientsSharedConfig.dockerCompose.projectName }_${ this.dateISOString.toLowerCase() }`; @@ -34,8 +34,8 @@ class ExerciceRunCommand extends CommanderCommand { protected defineCommand() { this.command - .description('locally run an exercice') - .option('-p, --path <value>', 'exercice path', Config.folders.defaultLocalExercice) + .description('locally run an exercise') + .option('-p, --path <value>', 'exercise path', Config.folders.defaultLocalExercise) .action(this.commandAction.bind(this)); } @@ -47,61 +47,61 @@ class ExerciceRunCommand extends CommanderCommand { } protected async commandAction(options: any): Promise<void> { - const localExercicePath = options.path ?? Config.folders.defaultLocalExercice; + const localExercisePath = options.path ?? Config.folders.defaultLocalExercise; - let enonceFile: EnonceFile; - let exerciceDockerCompose: ExerciceDockerCompose; - let exerciceResultsValidation: ExerciceResultsValidation; + let assignmentFile: AssignmentFile; + let exerciseDockerCompose: ExerciseDockerCompose; + let exerciseResultsValidation: ExerciseResultsValidation; - // Step 1: Check requirements (if it's an exercice folder and if Docker deamon is running) + // Step 1: Check requirements (if it's an exercise folder and if Docker deamon is running) { console.log(chalk.cyan('Please wait while we are checking and creating dependencies...')); // Create result temp folder fs.mkdirSync(this.folderResultsVolume, { recursive: true }); fs.mkdirSync(this.folderResultsDojo, { recursive: true }); - fs.mkdirSync(this.folderResultsExercice, { recursive: true }); + fs.mkdirSync(this.folderResultsExercise, { recursive: true }); ora({ - text : `Checking exercice content:`, + text : `Checking exercise content:`, indent: 4 }).start().info(); - // Exercice folder + // Exercise folder { const spinner: ora.Ora = ora({ - text : `Checking exercice folder`, + text : `Checking exercise folder`, indent: 8 }).start(); const files = fs.readdirSync(options.path); - const missingFiles = Config.exercice.neededFiles.map((file: string): [ string, boolean ] => [ file, files.includes(file) ]).filter((file: [ string, boolean ]) => !file[1]); + const missingFiles = Config.exercise.neededFiles.map((file: string): [ string, boolean ] => [ file, files.includes(file) ]).filter((file: [ string, boolean ]) => !file[1]); if ( missingFiles.length > 0 ) { - spinner.fail(`The exercice folder is missing the following files: ${ missingFiles.map((file: [ string, boolean ]) => file[0]).join(', ') }`); + spinner.fail(`The exercise folder is missing the following files: ${ missingFiles.map((file: [ string, boolean ]) => file[0]).join(', ') }`); return; } - spinner.succeed(`The exercice folder contains all the needed files`); + spinner.succeed(`The exercise folder contains all the needed files`); } - // dojo.enonce validity + // dojo.assignment validity { const spinner: ora.Ora = ora({ - text : `Checking ${ Config.enonce.filename } file`, + text : `Checking ${ Config.assignment.filename } file`, indent: 8 }).start(); - const validationResults = SharedEnonceHelper.validateDescriptionFile(`${ options.path }/${ Config.enonce.filename }`); + const validationResults = SharedAssignmentHelper.validateDescriptionFile(`${ options.path }/${ Config.assignment.filename }`); if ( !validationResults.isValid ) { - spinner.fail(`The ${ Config.enonce.filename } file is invalid: ${ JSON.stringify(validationResults.errors) }`); + spinner.fail(`The ${ Config.assignment.filename } file is invalid: ${ JSON.stringify(validationResults.errors) }`); return; } else { - enonceFile = validationResults.results!; + assignmentFile = validationResults.results!; } - spinner.succeed(`The ${ Config.enonce.filename } file is valid`); + spinner.succeed(`The ${ Config.assignment.filename } file is valid`); } // Docker deamon @@ -112,7 +112,7 @@ class ExerciceRunCommand extends CommanderCommand { }).start(); try { - await execAsync(`cd "${ Config.folders.defaultLocalExercice }";docker ps`); + await execAsync(`cd "${ Config.folders.defaultLocalExercise }";docker ps`); } catch ( error ) { spinner.fail(`The Docker deamon is not running`); return; @@ -125,27 +125,27 @@ class ExerciceRunCommand extends CommanderCommand { // Step 2: Run docker-compose file { - console.log(chalk.cyan('Please wait while we are running the exercice...')); + console.log(chalk.cyan('Please wait while we are running the exercise...')); - const composeOverridePath: string = path.join(localExercicePath, 'docker-compose-override.yml'); + const composeOverridePath: string = path.join(localExercisePath, 'docker-compose-override.yml'); - const composeOverride = fs.readFileSync(path.join(__dirname, '../../../assets/docker-compose-override.yml'), 'utf8').replace('{{VOLUME_NAME}}', enonceFile.result.volume).replace('{{MOUNT_PATH}}', this.folderResultsExercice); + const composeOverride = fs.readFileSync(path.join(__dirname, '../../../assets/docker-compose-override.yml'), 'utf8').replace('{{VOLUME_NAME}}', assignmentFile.result.volume).replace('{{MOUNT_PATH}}', this.folderResultsExercise); fs.writeFileSync(composeOverridePath, composeOverride); - exerciceDockerCompose = new ExerciceDockerCompose(this.projectName, enonceFile, localExercicePath, [ composeOverridePath ]); + exerciseDockerCompose = new ExerciseDockerCompose(this.projectName, assignmentFile, localExercisePath, [ composeOverridePath ]); try { await new Promise<void>((resolve, reject) => { let spinner: ora.Ora; - exerciceDockerCompose.events.on('step', (name: string, message: string) => { + exerciseDockerCompose.events.on('step', (name: string, message: string) => { spinner = ora({ text : message, indent: 4 }).start(); }); - exerciceDockerCompose.events.on('endStep', (stepName: string, message: string, error: boolean) => { + exerciseDockerCompose.events.on('endStep', (stepName: string, message: string, error: boolean) => { if ( error ) { spinner.fail(message); } else { @@ -153,18 +153,18 @@ class ExerciceRunCommand extends CommanderCommand { } }); - exerciceDockerCompose.events.on('finished', (success: boolean, exitCode: number) => { + exerciseDockerCompose.events.on('finished', (success: boolean, exitCode: number) => { success ? resolve() : reject(); }); - exerciceDockerCompose.run(true); + exerciseDockerCompose.run(true); }); } catch ( error ) { } fs.rmSync(composeOverridePath); - fs.writeFileSync(this.fileComposeLogs, exerciceDockerCompose.allLogs); + fs.writeFileSync(this.fileComposeLogs, exerciseDockerCompose.allLogs); - if ( !exerciceDockerCompose.success ) { + if ( !exerciseDockerCompose.success ) { this.displayExecutionLogs(); return; } @@ -175,20 +175,20 @@ class ExerciceRunCommand extends CommanderCommand { { console.log(chalk.cyan('Please wait while we are checking the results...')); - exerciceResultsValidation = new ExerciceResultsValidation(this.folderResultsDojo, this.folderResultsExercice); + exerciseResultsValidation = new ExerciseResultsValidation(this.folderResultsDojo, this.folderResultsExercise); try { await new Promise<void>((resolve, reject) => { let spinner: ora.Ora; - exerciceResultsValidation.events.on('step', (name: string, message: string) => { + exerciseResultsValidation.events.on('step', (name: string, message: string) => { spinner = ora({ text : message, indent: 4 }).start(); }); - exerciceResultsValidation.events.on('endStep', (stepName: string, message: string, error: boolean) => { + exerciseResultsValidation.events.on('endStep', (stepName: string, message: string, error: boolean) => { if ( error ) { if ( stepName == 'CHECK_SIZE' ) { spinner.warn(message); @@ -200,11 +200,11 @@ class ExerciceRunCommand extends CommanderCommand { } }); - exerciceResultsValidation.events.on('finished', (success: boolean, exitCode: number) => { - success || exitCode == ExerciceCheckerError.EXERCICE_RESULTS_FOLDER_TOO_BIG ? resolve() : reject(); + exerciseResultsValidation.events.on('finished', (success: boolean, exitCode: number) => { + success || exitCode == ExerciseCheckerError.EXERCISE_RESULTS_FOLDER_TOO_BIG ? resolve() : reject(); }); - exerciceResultsValidation.run(); + exerciseResultsValidation.run(); }); } catch ( error ) { this.displayExecutionLogs(); @@ -215,7 +215,7 @@ class ExerciceRunCommand extends CommanderCommand { // Step 4: Display results + Volume location { - ClientsSharedExerciceHelper.displayExecutionResults(exerciceResultsValidation.exerciceResults!, exerciceDockerCompose.exitCode, { + ClientsSharedExerciseHelper.displayExecutionResults(exerciseResultsValidation.exerciseResults!, exerciseDockerCompose.exitCode, { INFO : chalk.bold, SUCCESS: chalk.green, FAILURE: chalk.red @@ -225,4 +225,4 @@ class ExerciceRunCommand extends CommanderCommand { } -export default new ExerciceRunCommand(); \ No newline at end of file +export default new ExerciseRunCommand(); \ No newline at end of file diff --git a/NodeApp/src/config/Config.ts b/NodeApp/src/config/Config.ts index c384a41f4a513b6cb6002e31301366fcf99b0b82..dca31f4290df75bdce9722cc600bdcbc640a1078 100644 --- a/NodeApp/src/config/Config.ts +++ b/NodeApp/src/config/Config.ts @@ -7,14 +7,14 @@ class Config { }; public readonly folders: { - defaultLocalExercice: string + defaultLocalExercise: string }; - public enonce: { + public assignment: { filename: string }; - public readonly exercice: { + public readonly exercise: { neededFiles: Array<string> }; @@ -25,15 +25,15 @@ class Config { }; this.folders = { - defaultLocalExercice: process.env.LOCAL_EXERCICE_DEFAULT_FOLDER || './' + defaultLocalExercise: process.env.LOCAL_EXERCISE_DEFAULT_FOLDER || './' }; - this.enonce = { - filename: process.env.ENONCE_FILENAME || '' + this.assignment = { + filename: process.env.ASSIGNMENT_FILENAME || '' }; - this.exercice = { - neededFiles: JSON.parse(process.env.EXERCICE_NEEDED_FILES || '[]') + this.exercise = { + neededFiles: JSON.parse(process.env.EXERCISE_NEEDED_FILES || '[]') }; } } diff --git a/NodeApp/src/managers/DojoBackendManager.ts b/NodeApp/src/managers/DojoBackendManager.ts index d9283bb71e1c078aef506c06eebc439b76fad69e..64c56cb34e1e25cc4b0fb3198d09d94e4b5993dd 100644 --- a/NodeApp/src/managers/DojoBackendManager.ts +++ b/NodeApp/src/managers/DojoBackendManager.ts @@ -2,11 +2,11 @@ import axios, { AxiosError } from 'axios'; import ora from 'ora'; import ApiRoute from '../sharedByClients/types/Dojo/ApiRoute'; import { StatusCodes } from 'http-status-codes'; -import Enonce from '../sharedByClients/models/Enonce'; import GitlabUser from '../shared/types/Gitlab/GitlabUser'; -import Exercice from '../sharedByClients/models/Exercice'; -import DojoResponse from '../shared/types/Dojo/DojoResponse'; import ClientsSharedConfig from '../sharedByClients/config/ClientsSharedConfig'; +import Assignment from '../sharedByClients/models/Assignment'; +import DojoBackendResponse from '../shared/types/Dojo/DojoBackendResponse'; +import Exercise from '../sharedByClients/models/Exercise'; class DojoBackendManager { @@ -14,9 +14,9 @@ class DojoBackendManager { return `${ ClientsSharedConfig.apiURL }${ route }`; } - public async getEnonce(nameOrUrl: string): Promise<Enonce | undefined> { + public async getAssignment(nameOrUrl: string): Promise<Assignment | undefined> { try { - return (await axios.get<DojoResponse<Enonce>>(this.getApiUrl(ApiRoute.ENONCE_GET).replace('{{nameOrUrl}}', encodeURIComponent(nameOrUrl)))).data.data; + return (await axios.get<DojoBackendResponse<Assignment>>(this.getApiUrl(ApiRoute.ASSIGNMENT_GET).replace('{{nameOrUrl}}', encodeURIComponent(nameOrUrl)))).data.data; } catch ( error ) { return undefined; } @@ -59,21 +59,21 @@ class DojoBackendManager { } } - public async createEnonce(name: string, members: Array<GitlabUser>, templateIdOrNamespace: string | null, verbose: boolean = true): Promise<Enonce> { - const spinner: ora.Ora = ora('Creating enonce...'); + public async createAssignment(name: string, members: Array<GitlabUser>, templateIdOrNamespace: string | null, verbose: boolean = true): Promise<Assignment> { + const spinner: ora.Ora = ora('Creating assignment...'); if ( verbose ) { spinner.start(); } try { - const response = await axios.post<DojoResponse<Enonce>>(this.getApiUrl(ApiRoute.ENONCE_CREATE), Object.assign({ - name : name, - members: JSON.stringify(members) - }, templateIdOrNamespace ? { template: templateIdOrNamespace } : {})); + const response = await axios.post<DojoBackendResponse<Assignment>>(this.getApiUrl(ApiRoute.ASSIGNMENT_CREATE), Object.assign({ + name : name, + members: JSON.stringify(members) + }, templateIdOrNamespace ? { template: templateIdOrNamespace } : {})); if ( verbose ) { - spinner.succeed(`Enonce successfully created`); + spinner.succeed(`Assignment successfully created`); } return response.data.data; @@ -82,13 +82,13 @@ class DojoBackendManager { if ( error instanceof AxiosError ) { if ( error.response ) { if ( error.response.status === StatusCodes.CONFLICT ) { - spinner.fail(`The enonce name is already used. Please choose another one.`); + spinner.fail(`The assignment name is already used. Please choose another one.`); } else { - spinner.fail(`Enonce creation error: ${ error.response.statusText }`); + spinner.fail(`Assignment creation error: ${ error.response.statusText }`); } } } else { - spinner.fail(`Enonce creation error: unknown error`); + spinner.fail(`Assignment creation error: unknown error`); } } @@ -96,18 +96,18 @@ class DojoBackendManager { } } - public async createExercice(enonceName: string, members: Array<GitlabUser>, verbose: boolean = true): Promise<Exercice> { - const spinner: ora.Ora = ora('Creating exercice...'); + public async createExercise(assignmentName: string, members: Array<GitlabUser>, verbose: boolean = true): Promise<Exercise> { + const spinner: ora.Ora = ora('Creating exercise...'); if ( verbose ) { spinner.start(); } try { - const response = await axios.post<DojoResponse<Exercice>>(this.getApiUrl(ApiRoute.EXERCICE_CREATE).replace('{{nameOrUrl}}', encodeURIComponent(enonceName)), { members: JSON.stringify(members) }); + const response = await axios.post<DojoBackendResponse<Exercise>>(this.getApiUrl(ApiRoute.EXERCISE_CREATE).replace('{{nameOrUrl}}', encodeURIComponent(assignmentName)), { members: JSON.stringify(members) }); if ( verbose ) { - spinner.succeed(`Exercice successfully created`); + spinner.succeed(`Exercise successfully created`); } return response.data.data; @@ -116,13 +116,13 @@ class DojoBackendManager { if ( error instanceof AxiosError ) { if ( error.response ) { if ( error.response.status === StatusCodes.CONFLICT ) { - spinner.fail(`You've reached the max number of exercice of this enonce.`); + spinner.fail(`You've already reached the max number of exercise of this assignment.`); } else { - spinner.fail(`Exercice creation error: ${ error.response.statusText }`); + spinner.fail(`Exercise creation error: ${ error.response.statusText }`); } } } else { - spinner.fail(`Exercice creation error: unknown error`); + spinner.fail(`Exercise creation error: unknown error`); } } @@ -130,7 +130,7 @@ class DojoBackendManager { } } - public async changeEnoncePublishedStatus(enonce: Enonce, publish: boolean, verbose: boolean = true) { + public async changeAssignmentPublishedStatus(assignment: Assignment, publish: boolean, verbose: boolean = true) { const spinner: ora.Ora = ora('Changing published status...'); if ( verbose ) { @@ -138,19 +138,19 @@ class DojoBackendManager { } try { - await axios.patch<DojoResponse<null>>(this.getApiUrl(publish ? ApiRoute.ENONCE_PUBLISH : ApiRoute.ENONCE_UNPUBLISH).replace('{{nameOrUrl}}', encodeURIComponent(enonce.name)), {}); + await axios.patch<DojoBackendResponse<null>>(this.getApiUrl(publish ? ApiRoute.ASSIGNMENT_PUBLISH : ApiRoute.ASSIGNMENT_UNPUBLISH).replace('{{nameOrUrl}}', encodeURIComponent(assignment.name)), {}); if ( verbose ) { - spinner.succeed(`Enonce ${ enonce.name } successfully ${ publish ? 'published' : 'unpublished' }`); + spinner.succeed(`Assignment ${ assignment.name } successfully ${ publish ? 'published' : 'unpublished' }`); } return; } catch ( error ) { if ( verbose ) { if ( error instanceof AxiosError && error.response ) { - spinner.fail(`Enonce visibility change error: ${ error.response.statusText }`); + spinner.fail(`Assignment visibility change error: ${ error.response.statusText }`); } else { - spinner.fail(`Enonce visibility change error: unknown error`); + spinner.fail(`Assignment visibility change error: unknown error`); } } diff --git a/NodeApp/src/shared b/NodeApp/src/shared index f33e4e0c7b34f9060e8995550920d25cd3e73c40..8d7e3ca0cca10e874ac48e19e47da8a1491ccba7 160000 --- a/NodeApp/src/shared +++ b/NodeApp/src/shared @@ -1 +1 @@ -Subproject commit f33e4e0c7b34f9060e8995550920d25cd3e73c40 +Subproject commit 8d7e3ca0cca10e874ac48e19e47da8a1491ccba7 diff --git a/NodeApp/src/sharedByClients b/NodeApp/src/sharedByClients index 8872f91f280e60287c4dba46de58f3f412e0a462..4ff3846e9415a6122b0b966be089eec3f0117f4f 160000 --- a/NodeApp/src/sharedByClients +++ b/NodeApp/src/sharedByClients @@ -1 +1 @@ -Subproject commit 8872f91f280e60287c4dba46de58f3f412e0a462 +Subproject commit 4ff3846e9415a6122b0b966be089eec3f0117f4f