Split (1)

train · 14.1k rows

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.

text stringlengths 1 2.83M	id stringlengths 16 152	metadata dict	__index_level_0__ int64 0 949
Bugfix: Introduce "upload finalizing"-state in upload overlay The "upload finalizing"-state has been introduced to the upload overlay. This state is relevant during the time window when all data has been transferred to the server (= progress bar is at 100%), but the server still needs to write all data to the storage. The "cancel"- and "pause"-actions are disabled during the "upload finalizing"-state as the data transfer is technically finished. Previously, when pausing and resuming when being in this state, the upload would be marked as successful instantly, despite the server still writing to the storage. https://github.com/owncloud/web/issues/7956 https://github.com/owncloud/web/pull/7974 https://github.com/owncloud/web/pull/7999	owncloud/web/changelog/6.0.0_2022-11-29/bugfix-upload-finalizing-state/0	{ "file_path": "owncloud/web/changelog/6.0.0_2022-11-29/bugfix-upload-finalizing-state", "repo_id": "owncloud", "token_count": 180 }	597
Enhancement: Enable renaming on received shares As a receiver the user can rename a share which will only take effect for the respective user but won't change the name for the sharee or other share receivers. https://github.com/owncloud/web/pull/7725 https://github.com/owncloud/web/issues/6247	owncloud/web/changelog/6.0.0_2022-11-29/enhancement-enable-renaming-received-shares/0	{ "file_path": "owncloud/web/changelog/6.0.0_2022-11-29/enhancement-enable-renaming-received-shares", "repo_id": "owncloud", "token_count": 80 }	598
Bugfix: Application menu active display on hover The text color of the active application menu item on hover as been fixed. https://github.com/owncloud/web/pull/8265	owncloud/web/changelog/7.0.0_2023-06-02/bugfix-app-menu-active-display/0	{ "file_path": "owncloud/web/changelog/7.0.0_2023-06-02/bugfix-app-menu-active-display", "repo_id": "owncloud", "token_count": 44 }	599
Bugfix: Hide upload hint in empty read-only folders Empty read-only folders now don't show the upload hint to the user. https://github.com/owncloud/web/issues/8834 https://github.com/owncloud/web/pull/8846	owncloud/web/changelog/7.0.0_2023-06-02/bugfix-hide-upload-hint-in-read-only-folders/0	{ "file_path": "owncloud/web/changelog/7.0.0_2023-06-02/bugfix-hide-upload-hint-in-read-only-folders", "repo_id": "owncloud", "token_count": 64 }	600
Bugfix: Paste action conflict dialog broken We've fixed a bug that resulted in the paste action not doing anything in cases of a conflict https://github.com/owncloud/web/pull/8480 https://github.com/owncloud/web/issues/8462	owncloud/web/changelog/7.0.0_2023-06-02/bugfix-paste-action-conflict-dialog-broken/0	{ "file_path": "owncloud/web/changelog/7.0.0_2023-06-02/bugfix-paste-action-conflict-dialog-broken", "repo_id": "owncloud", "token_count": 62 }	601
Bugfix: Select all checkbox We've fixed a bug in the shared-with-me page which caused unrelated checkboxes to be checked. https://github.com/owncloud/web/pull/9131 https://github.com/owncloud/web/issues/9122	owncloud/web/changelog/7.0.0_2023-06-02/bugfix-select-all-checkbox/0	{ "file_path": "owncloud/web/changelog/7.0.0_2023-06-02/bugfix-select-all-checkbox", "repo_id": "owncloud", "token_count": 65 }	602
Bugfix: Users without role assignment Listing and editing users without a role assignment in the admin settings has been fixed. https://github.com/owncloud/web/issues/8585 https://github.com/owncloud/web/pull/8590	owncloud/web/changelog/7.0.0_2023-06-02/bugfix-users-without-role-assignment/0	{ "file_path": "owncloud/web/changelog/7.0.0_2023-06-02/bugfix-users-without-role-assignment", "repo_id": "owncloud", "token_count": 60 }	603
Enhancement: Batch edit quota in admin panel We've added the batch edit quota functionality to the admin panel for users personal space and in the spaces list https://github.com/owncloud/web/pull/8387 https://github.com/owncloud/web/pull/8430 https://github.com/owncloud/web/pull/8438 https://github.com/owncloud/web/pull/8555 https://github.com/owncloud/web/pull/8603 https://github.com/owncloud/web/issues/8417	owncloud/web/changelog/7.0.0_2023-06-02/enhancement-admin-change-spaces-quota-batch-action/0	{ "file_path": "owncloud/web/changelog/7.0.0_2023-06-02/enhancement-admin-change-spaces-quota-batch-action", "repo_id": "owncloud", "token_count": 132 }	604
Enhancement: Create Space from selection We've added a new action 'Create Space from selection' to the users personal home so they can create a Space with the copied content of their selected files and folders. https://github.com/owncloud/web/pull/8730 https://github.com/owncloud/web/issues/8735	owncloud/web/changelog/7.0.0_2023-06-02/enhancement-create-space-from-selection/0	{ "file_path": "owncloud/web/changelog/7.0.0_2023-06-02/enhancement-create-space-from-selection", "repo_id": "owncloud", "token_count": 80 }	605
Enhancement: Slight improvement of key up/down performance The render performance of the key up/down events in file lists has been improved slightly. https://github.com/owncloud/web/pull/8356	owncloud/web/changelog/7.0.0_2023-06-02/enhancement-key-up-down-performance/0	{ "file_path": "owncloud/web/changelog/7.0.0_2023-06-02/enhancement-key-up-down-performance", "repo_id": "owncloud", "token_count": 51 }	606
Enhancement: Rename "Quicklink" to "link" We've renamed "Quicklink" to "link" in the UI https://github.com/owncloud/web/pull/8898 https://github.com/owncloud/web/issues/7891	owncloud/web/changelog/7.0.0_2023-06-02/enhancement-rename-quicklink-to-link/0	{ "file_path": "owncloud/web/changelog/7.0.0_2023-06-02/enhancement-rename-quicklink-to-link", "repo_id": "owncloud", "token_count": 64 }	607
Enhancement: Spaces list in admin settings The admin settings now have a view to list all spaces for the current instance. This makes it possible for space admins to manage all spaces in one place. https://github.com/owncloud/web/pull/8178 https://github.com/owncloud/web/pull/8195 https://github.com/owncloud/web/pull/8190 https://github.com/owncloud/web/pull/8192 https://github.com/owncloud/web/pull/8199 https://github.com/owncloud/web/pull/8224 https://github.com/owncloud/web/pull/8228 https://github.com/owncloud/web/pull/8229 https://github.com/owncloud/web/pull/8231 https://github.com/owncloud/web/pull/8236 https://github.com/owncloud/web/pull/8238 https://github.com/owncloud/web/pull/8234 https://github.com/owncloud/web/pull/8249 https://github.com/owncloud/web/pull/8230 https://github.com/owncloud/web/pull/8262 https://github.com/owncloud/web/pull/8247 https://github.com/owncloud/web/pull/8273 https://github.com/owncloud/web/pull/8268 https://github.com/owncloud/web/pull/8233 https://github.com/owncloud/web/pull/8333 https://github.com/owncloud/web/pull/8334 https://github.com/owncloud/web/pull/8477 https://github.com/owncloud/web/issues/8219 https://github.com/owncloud/web/issues/8267	owncloud/web/changelog/7.0.0_2023-06-02/enhancement-spaces-list-in-admin-settings/0	{ "file_path": "owncloud/web/changelog/7.0.0_2023-06-02/enhancement-spaces-list-in-admin-settings", "repo_id": "owncloud", "token_count": 428 }	608
Bugfix: Space creation does not block reoccurring event We've fixed a bug that caused multiple spaces to be created in case of a slow internet connection and if the user clicks confirm multiple times. https://github.com/owncloud/web/pull/9213 https://github.com/owncloud/web/issues/9189	owncloud/web/changelog/7.1.0_2023-08-23/bugfix-create-new-space-reoccurring/0	{ "file_path": "owncloud/web/changelog/7.1.0_2023-08-23/bugfix-create-new-space-reoccurring", "repo_id": "owncloud", "token_count": 76 }	609
Enhancement: Add whitespace context-menu We've added a generic context-menu for right clicking on whitespace. https://github.com/owncloud/web/pull/8921 https://github.com/owncloud/web/issues/5861	owncloud/web/changelog/7.1.0_2023-08-23/enhancement-add-whitespace-context-menu/0	{ "file_path": "owncloud/web/changelog/7.1.0_2023-08-23/enhancement-add-whitespace-context-menu", "repo_id": "owncloud", "token_count": 61 }	610
Enhancement: Resolve pulic links to their actual location Public links are now being resolved to their actual location if the user has proper access to the resource (either via space or share). https://github.com/owncloud/web/pull/9299 https://github.com/owncloud/web/issues/9296	owncloud/web/changelog/7.1.0_2023-08-23/enhancement-resolve-public-link-to-actual-location/0	{ "file_path": "owncloud/web/changelog/7.1.0_2023-08-23/enhancement-resolve-public-link-to-actual-location", "repo_id": "owncloud", "token_count": 75 }	611
Bugfix: Private link resolving via share jail ID Resolving private links via the share jail ID has been fixed. https://github.com/owncloud/web/pull/9913 https://github.com/owncloud/web/issues/9867	owncloud/web/changelog/7.1.2_2023-11-16/bugfix-resolving-via-share-jail-id/0	{ "file_path": "owncloud/web/changelog/7.1.2_2023-11-16/bugfix-resolving-via-share-jail-id", "repo_id": "owncloud", "token_count": 59 }	612
Bugfix: Create .space folder if it does not exist Creating .space folder and README.md in space if folder has been removed by user. https://github.com/owncloud/web/issues/9788 https://github.com/owncloud/web/pull/9793	owncloud/web/changelog/8.0.0_2024-03-08/bugfix-hidden-space-folder/0	{ "file_path": "owncloud/web/changelog/8.0.0_2024-03-08/bugfix-hidden-space-folder", "repo_id": "owncloud", "token_count": 67 }	613
Bugfix: Restore space We've fixed a bug where restoring a space was not possible in some constellations for (space) admins. https://github.com/owncloud/web/pull/10424	owncloud/web/changelog/8.0.0_2024-03-08/bugfix-restore-space/0	{ "file_path": "owncloud/web/changelog/8.0.0_2024-03-08/bugfix-restore-space", "repo_id": "owncloud", "token_count": 48 }	614
Change: DavProperties without namespace The `DavProperties` coming from the `web-client` package don't include their namespace anymore. E.g. `{http://owncloud.org/ns}fileid` has now become `fileid`. This change was part of moving away from the WebDAV implementation of the ownCloudSDK in favor of a new implementation in `web-client`. There is a new subset `DavProperties.DavNamespace` to identify all properties living under the default namespace `{DAV:}`. All other properties live under the owncloud namespace `{http://owncloud.org/ns}`. https://github.com/owncloud/web/issues/9709 https://github.com/owncloud/web/pull/9764	owncloud/web/changelog/8.0.0_2024-03-08/change-dav-properties-without-namespace/0	{ "file_path": "owncloud/web/changelog/8.0.0_2024-03-08/change-dav-properties-without-namespace", "repo_id": "owncloud", "token_count": 177 }	615
Enhancement: Create shortcuts We've added a new functionality to add to shortcuts to web, those can be created via the "+ New" context menu. Users can enter URLs or pick a file via the drop down menu and create a '.url' file. '.url' files can be opened via web or downloaded and opened on the desktop. https://github.com/owncloud/web/pull/9890 https://github.com/owncloud/web/pull/9908 https://github.com/owncloud/web/pull/9936 https://github.com/owncloud/web/pull/9971 https://github.com/owncloud/web/issues/9796 https://github.com/owncloud/web/issues/9887 https://github.com/owncloud/web/issues/9850 https://github.com/owncloud/web/issues/9963 https://github.com/owncloud/web/issues/9969	owncloud/web/changelog/8.0.0_2024-03-08/enhancement-create-shortcuts/0	{ "file_path": "owncloud/web/changelog/8.0.0_2024-03-08/enhancement-create-shortcuts", "repo_id": "owncloud", "token_count": 220 }	616
Enhancement: Harmonize AppSwitcher icon colors We've adjusted the AppSwitcher icon colors to be more inline with the design. https://github.com/owncloud/web/pull/10224 https://github.com/owncloud/web/issues/10121	owncloud/web/changelog/8.0.0_2024-03-08/enhancement-harmonize-appswitcher-icon-colors/0	{ "file_path": "owncloud/web/changelog/8.0.0_2024-03-08/enhancement-harmonize-appswitcher-icon-colors", "repo_id": "owncloud", "token_count": 64 }	617
Enhancement: Search query term linking We've added the option to search for multiple terms with the same type, at the moment only the tag search benefits from it. This makes it possible to search for multiple resources with different tags in one query. The UI now empowers the user to perform advanced searches like: * all resources with the tags `tag1` OR `tag2` * all resources with the tags `tag1` OR `tag2` AND containing text `content` as a rule of thumb, if a property appears multiple times (like `tag1` OR `tag2`) the search combines the query with an `OR` and different keys are linked with an `AND`. https://github.com/owncloud/web/pull/9854 https://github.com/owncloud/web/issues/9829	owncloud/web/changelog/8.0.0_2024-03-08/enhancement-search-term-linking/0	{ "file_path": "owncloud/web/changelog/8.0.0_2024-03-08/enhancement-search-term-linking", "repo_id": "owncloud", "token_count": 189 }	618
Bugfix: Add link in right sidebar sharing menu, doesn't copy link to clipboard We've fixed a bug, where clicking the add link button in the right sidebar sharing menu, created a new link but didn't copy it to the clipboard. https://github.com/owncloud/web/pull/10573 https://github.com/owncloud/web/pull/10581 https://github.com/owncloud/web/issues/10563	owncloud/web/changelog/8.0.1_2024-03-12/bugfix-add-link-does-not-copy-to-clipboard/0	{ "file_path": "owncloud/web/changelog/8.0.1_2024-03-12/bugfix-add-link-does-not-copy-to-clipboard", "repo_id": "owncloud", "token_count": 102 }	619
Change: Remove skeleton app Due to improvements in the extension system in general, we have removed the skeleton app. Documentation regarding the extension API and guides/examples can be found in the dev docs. https://github.com/owncloud/web/issues/9892 https://github.com/owncloud/web/pull/10067	owncloud/web/changelog/9.0.0_2024-02-26/change-remove-skeleton-app/0	{ "file_path": "owncloud/web/changelog/9.0.0_2024-02-26/change-remove-skeleton-app", "repo_id": "owncloud", "token_count": 78 }	620
Enhancement: Top loading bar increase visibility We've improved the visibility in the top loading bar, the height has been increased along with the color contrast. https://github.com/owncloud/web/issues/10383	owncloud/web/changelog/9.0.0_2024-02-26/enhancement-top-loading-bar-increase-visibility/0	{ "file_path": "owncloud/web/changelog/9.0.0_2024-02-26/enhancement-top-loading-bar-increase-visibility", "repo_id": "owncloud", "token_count": 51 }	621
--- policy_selector: static: policy: ocis policies: - name: ocis routes: # serve oC Web assets from the Web container - endpoint: / backend: http://web:8080 unprotected: true # servce oC Web config from oCIS - endpoint: /config.json backend: http://localhost:9100 unprotected: true # begin of regular oCIS proxy configuration # we don't need the root rule for oC Web, since we replaced it # with the both rules above # - endpoint: / # service: com.owncloud.web.web # unprotected: true - endpoint: /.well-known/webfinger service: com.owncloud.web.webfinger unprotected: true - endpoint: /.well-known/openid-configuration service: com.owncloud.web.idp unprotected: true - endpoint: /branding/logo service: com.owncloud.web.web - endpoint: /konnect/ service: com.owncloud.web.idp unprotected: true - endpoint: /signin/ service: com.owncloud.web.idp unprotected: true - endpoint: /archiver service: com.owncloud.web.frontend - endpoint: /ocs/v2.php/apps/notifications/api/v1/notifications service: com.owncloud.userlog.userlog - type: regex endpoint: /ocs/v[12].php/cloud/user/signing-key service: com.owncloud.web.ocs - type: regex endpoint: /ocs/v[12].php/config service: com.owncloud.web.frontend unprotected: true - endpoint: /ocs/ service: com.owncloud.web.frontend - type: query endpoint: /remote.php/?preview=1 service: com.owncloud.web.webdav - method: REPORT endpoint: /remote.php/dav/ service: com.owncloud.web.webdav - method: REPORT endpoint: /remote.php/webdav service: com.owncloud.web.webdav - method: REPORT endpoint: /dav/spaces service: com.owncloud.web.webdav - type: query endpoint: /dav/?preview=1 service: com.owncloud.web.webdav - type: query endpoint: /webdav/?preview=1 service: com.owncloud.web.webdav - endpoint: /remote.php/ service: com.owncloud.web.ocdav - endpoint: /dav/ service: com.owncloud.web.ocdav - endpoint: /webdav/ service: com.owncloud.web.ocdav - endpoint: /status service: com.owncloud.web.ocdav unprotected: true - endpoint: /status.php service: com.owncloud.web.ocdav unprotected: true - endpoint: /index.php/ service: com.owncloud.web.ocdav - endpoint: /apps/ service: com.owncloud.web.ocdav - endpoint: /data service: com.owncloud.web.frontend unprotected: true - endpoint: /app/list service: com.owncloud.web.frontend unprotected: true - endpoint: /app/ service: com.owncloud.web.frontend - endpoint: /graph/v1.0/invitations service: com.owncloud.graph.invitations - endpoint: /graph/ service: com.owncloud.graph.graph - endpoint: /api/v0/settings service: com.owncloud.web.settings	owncloud/web/deployments/examples/ocis_web/config/ocis/proxy.yaml/0	{ "file_path": "owncloud/web/deployments/examples/ocis_web/config/ocis/proxy.yaml", "repo_id": "owncloud", "token_count": 1448 }	622
# for m1 use SELENIUM_IMAGE=seleniarm/standalone-chromium:4.7.0-20221206 docker-compose run selenium ARG SELENIUM_IMAGE FROM ${SELENIUM_IMAGE} RUN sudo apt -qqy update \ && sudo apt -qqy --no-install-recommends install \ fonts-indic \ && sudo rm -rf /var/lib/apt/lists/* \ && sudo apt -qyy clean	owncloud/web/dev/docker/selenium.Dockerfile/0	{ "file_path": "owncloud/web/dev/docker/selenium.Dockerfile", "repo_id": "owncloud", "token_count": 127 }	623
--- title: 'Repo structure and (published) packages' date: 2022-01-28T00:00:00+00:00 weight: 30 geekdocRepo: https://github.com/owncloud/web geekdocEditPath: edit/master/docs/development geekdocFilePath: repo-structure.md --- {{< toc >}} ## Repository Structure From a developer's perspective, the most important parts of the [ownCloud Web repo](https://github.com/owncloud/web) are the following files and folders: ### dev Folder and docker-compose.yml File The `/dev` folder contains all the configuration files that are needed in the `docker-compose.yml` file. This docker compose stack contains all the backend and testing related infrastructure that is needed for an out-of-the-box usable localhost development setup, as described in the [tooling section]({{< ref "tooling.md" >}}). ### docs Folder Within the `/docs` folder you will find all the documentation source documents that get published to the [dev docs](https://owncloud.dev/clients/web/). ### packages Folder We're using the [ownCloud Web repo](https://github.com/owncloud/web) as a mono repo. It contains a variety of packages. Some of them get published to [npmjs.com](https://npmjs.com), others define the core packages, apps and extensions that are the foundation of the `ownCloud Web` release artifact. Having these packages side by side within the `/packages` folder of the repo is possible because of a `pnpm` feature called `Workspaces`. You can learn more about that by visiting the [pnpm docs](https://pnpm.io/workspaces). ### tests Folder For historic reasons, there are two end-to-end test collections in the ownCloud Web project. The older one lives in `/tests/acceptance`, using [Nightwatch.js](https://nightwatchjs.org). The newer one lives in `/tests/e2e`, using [Playwright](https://playwright.dev). We're slowly moving away from the nightwatch.js-based e2e tests. As our coverage with playwright based e2e tests grows continuously, it might happen that you will not find the `/tests/acceptance` folder anymore. If that's the case at the time of reading this, those are happy times. You're more than welcome to make a pull request and adjust this section of the docs accordingly. :-) The rest of the folder contains helpers and configuration files for our automated testing infrastructure. You can read more about testing in our [testing section]({{< ref "../testing/_index.md" >}}) ### package.json File This is probably no surprise: the root level `package.json` file defines the project information, build scripts, dependencies and some more details. Each package in `/packages` can and most likely will contain another `package.json` which does the same for the respective package. ### vite.config.ts We're working with [Vite](https://vitejs.dev) as a local development server and build tool. `vite.config.ts` is the main configuration file for that. You can read more about the usage in our [tooling section]({{< ref "tooling.md" >}}). ## (Published) Packages Each package in the `/packages` folder can - not exclusively, but most commonly - consist of - source code (`/src`), - unit tests (`/tests`), - translations (`/l10n`) and - a `package.json` file for package specific details and dependencies. ### Code Style and Build Config Some of our packages in `/packages` are pure helper packages which ensure a common code style and build configuration for all our internal (mono repo) and external packages. We encourage you to make use of the very same packages. This helps the community understand code more easily, even when coming from different developers or vendors in the ownCloud Web ecosystem. Namely those packages are - `/packages/babel-preset` - `/packages/eslint-config` - `/packages/extension-sdk` - `/packages/prettier-config` - `/packages/tsconfig/` ### ownCloud Design System The ownCloud Design System (`/packages/design-system`) is a collection of components, design tokens and styles which ensure a unique and consistent look and feel and branding throughout the ownCloud Web ecosystem. We hope that you use it, too, so that your very own apps and extensions will blend in with all the others. Documentation and code examples can be found in the [design system documentation](https://owncloud.design). The ownCloud Design System is a standalone project, but to make development easier we have the code in our mono repo. We're planning to publish it on npmjs.com as [@ownclouders/design-system](https://www.npmjs.com/package/@ownclouders/design-system) as soon as possible. Since it's bundled with ownCloud Web, you should not bundle it with your app or extension. ### web-client The client package (`/packages/web-client`) serves as an abstraction layer for the various ownCloud APIs, like [LibreGraph](https://owncloud.dev/apis/http/graph/), [WebDAV](https://doc.owncloud.com/server/next/developer_manual/webdav_api/) and [OCS](https://doc.owncloud.com/server/next/developer_manual/core/apis/ocs-capabilities.html). The package provides TypeScript interfaces for various entities (like files, folders, shares and spaces) and makes sure that raw API responses are properly transformed so that you can deal with more useful objects. The web-client package gets published on npmjs.com as [@ownclouders/web-client](https://www.npmjs.com/package/@ownclouders/web-client). Dedicated documentation for the `web-client` package is not available, yet, since our extension system is still work in progress. ### web-pkg The web-pkg package (`/packages/web-pkg`) is a collection of opinionated components, composables, types and other helpers that aim at making your app and extension developer experience as easy and seamless as possible. The web-pkg package gets published on npmjs.com as [@ownclouders/web-pkg](https://www.npmjs.com/package/@ownclouders/web-pkg). Dedicated documentation for the `web-pkg` package is not available, yet, since our extension system is still work in progress. ### web-runtime At the very heart of ownCloud Web, the `web-runtime` is responsible for dependency injection, app bootstrapping, configuration, authentication, data preloading and much more. It is very likely that you will never get in touch with it as most of the developer-facing features are exposed via `web-pkg`. If you have more questions about this package, please join our [public chat](https://talk.owncloud.com/channel/web) and simply ask or write an issue in our [issue tracker](https://github.com/owncloud/web/issues). ### Standalone Core Apps Both `web-app-admin-settings` and `web-app-files` are standalone apps which are bundled with the default ownCloud Web release artifact. ### Viewer and Editor Apps Apps which fall into the categories `viewer` or `editor` can be opened from the context of a file or folder. This mostly happens from within the `files` app. We currently bundle the following apps with the default ownCloud Web release artifact: - `web-app-draw-io` an editor for `.drawio` files - `web-app-external` an iframe integration of all the apps coming from the [app provider](https://owncloud.dev/services/app-provider/) (e.g. OnlyOffice, Collabora Online and others) - `web-app-pdf-viewer` a viewer for `.pdf` files, which relies on native PDF rendering support from the browser - `web-app-preview` a viewer for various media files (audio / video / image formats) - `web-app-text-editor` a simple editor for `.txt`, `.md` and other plain text files If you're interested in writing your own viewer or editor app for certain file types, please get in touch with us for more info.	owncloud/web/docs/development/repo-structure.md/0	{ "file_path": "owncloud/web/docs/development/repo-structure.md", "repo_id": "owncloud", "token_count": 2013 }	624
--- title: 'Running tests' date: 2021-07-27T00:00:00+00:00 weight: 60 geekdocRepo: https://github.com/owncloud/web geekdocEditPath: edit/master/docs/testing geekdocFilePath: testing.md --- {{< toc >}} ## Introduction In order to allow us to make changes quickly, often and with a high level of confidence, we heavily rely on tests within the `web` repository. All the steps below require you to have the `web` repo cloned locally and dependencies installed. This can be achieved by running ```shell $ git clone https://github.com/owncloud/web.git $ cd web $ pnpm install ``` ### Unit Tests We have a steadily growing coverage of unit tests. You can run them locally via ```shell $ pnpm test:unit ``` You can also specify which tests to run by giving a path param, like so: `pnpm test:unit packages/<app-name>/tests/unit/path/to/test.spec.js`. #### Unit Test File Structure Our unit tests spec files follow a simple structure: - fixtures and mocks at the top - helper functions at the bottom - tests in between We usually organize tests with nested `describe` blocks. If you would like to get feedback from the core team about the structure, scope and goals of your unit tests before actually writing some, we invite you to make a pull request with only `describe` blocks and nested `it.todo("put your test description here")` lines. ### E2E Tests (Playwright) Our end-to-end test suite is built upon the [Playwright Framework](https://github.com/microsoft/playwright), which makes it easy to write tests, debug them and have them run cross-browser with minimal overhead. #### Preparation Please make sure you have installed all dependencies and started the server(s) as described in [tooling]({{< ref "tooling.md#development-setup" >}}). #### Prepare & Start Web Bundle the web frontend with the following command: ```shell $ pnpm build:w ``` Our compose setup automatically mounts it into an oCIS backend, respectively. Web also gets recompiled on changes. #### Run E2E Tests The following command will run all available e2e tests: ```shell $ pnpm test:e2e:cucumber 'tests/e2e/cucumber/*/.feature' ``` #### Options To run a particular test, simply add the feature file and line number to the test command, e.g. `pnpm test:e2e:cucumber tests/e2e/cucumber/features/smoke/admin-settings/users.feature:84` Various options are available via ENV variables, e.g. - `BASIC_AUTH=true` use basic authorization for api requests. - `RETRY=n` to retry failures `n` times - `SLOW_MO=n` to slow the execution time by `n` milliseconds - `TIMEOUT=n` to set tests to timeout after `n` milliseconds - `HEADLESS=bool` to open the browser while the tests run (defaults to true => headless mode) - `BROWSER=name` to run tests against a specific browser. Defaults to chromium, available are chromium, firefox, webkit, chromium - `ADMIN_PASSWORD` to set administrator password. By default, the `admin` password is used in the test For debugging reasons, you may want to record a video or traces of your test run. Again, you can use the following ENV variables in your command: - `REPORT_DIR=another/path` to set a directory for your recorded files (defaults to "reports") - `REPORT_VIDEO=true` to record a video of the test run - `REPORT_HAR=true` to save request information from the test run - `REPORT_TRACING=true` to record traces from the test run To then open e.g. the tracing from the `REPORT_DIR`, run ```shell $ npx playwright show-trace path/to/file.zip ``` #### Lint E2E Test Code Run the following command to find out the lint issues early in the test codes: ```shell $ pnpm lint ``` And to fix the lint problems run the following command: ```shell $ pnpm lint --fix ``` If the lint problems are not fixed by `--fix` option, we have to manually fix the code. ### Acceptance Tests (Nightwatch) {{< hint info >}} We've decided to switch to playwright for end-to-end tests. As we steadily increase the coverage of our playwright based e2e tests we keep the existing nightwatch based e2e tests maintained. However, we decided to not add new scenarios to the nightwatch based e2e tests anymore. In other words: only continue reading about our nightwatch based acceptance tests below if you need to debug a failing test. {{< /hint >}} At ownCloud, we have decided to adopt Docker as the main environment for developing our application. This also applies for running our acceptance tests. #### Preparation Please make sure you have installed all dependencies and started the server(s) as described in [tooling]({{< ref "tooling.md#development-setup" >}}). #### Prepare & Start Web Bundle the web frontend, which then gets mounted into the respective backends. It also gets recompiled on changes. ```shell $ pnpm build:w ``` #### Start Docker The acceptance tests need additional docker containers to be running. ```shell $ docker compose up ocis selenium middleware-ocis ``` and make sure there are no conflicting ports and everything runs smoothly. You can check if everything has worked by opening [https://host.docker.internal:9200](https://host.docker.internal:9200) and logging in using the demo user (admin/admin). If you're using a M1 Mac, you need to use `seleniarm/standalone-chromium:4.7.0-20221206`for now. To do so, export `SELENIUM_IMAGE=seleniarm/standalone-chromium:4.7.0-20221206`. #### Run acceptance tests - Change the directory to `tests/acceptance` - Install all the test dependencies with `pnpm install` command - Run the tests ```shell $ pnpm test:acceptance:ocis features/path/to/test ``` #### Watch the Test Run To watch the tests while running, open [http://host.docker.internal:7900/](http://host.docker.internal:7900/) in the browser to access your VNC client. ### Analyze the Test Report The cucumber library is used as the test runner for both e2e and acceptance tests. The report generator script lives inside the `tests/e2e/cucumber/report` folder. If you want to create a report after the tests are done, run the command: ```bash node tests/e2e/cucumber/report --report-input=tests/e2e/cucumber/report/report.json ``` `--report-input` is the path to the report file generated by the test runner. If you want to generate a report for the acceptance tests, you can run the command ```bash node tests/e2e/cucumber/report --report-input=tests/acceptance/report/report.json ``` By default, the report gets generated to reports/e2e/cucumber/releaseReport/cucumber_report.html. The location can be changed by adding the `--report-location` flag. To see all available options run ```bash node tests/e2e/cucumber/report --help ```	owncloud/web/docs/testing/testing.md/0	{ "file_path": "owncloud/web/docs/testing/testing.md", "repo_id": "owncloud", "token_count": 1922 }	625
const { sortProps } = require('./utils') module.exports = { name: 'format/ods/scss', formatter: (dictionary) => { const props = sortProps(dictionary.allProperties) const data = [ ...props.map((p) => `$${p.name}: ${p.value};`), '', ':host, :root {', ...props.map((p) => ` --${p.name}: #{$${p.name}};`), '}', '' ].join('\n') return data } }	owncloud/web/packages/design-system/build/build-tokens/format-writer-scss.js/0	{ "file_path": "owncloud/web/packages/design-system/build/build-tokens/format-writer-scss.js", "repo_id": "owncloud", "token_count": 193 }	626
Enhancement: Add new icons We've added new icons which can be used to symbolise adding new shares, creating links and shared with lists. We've also removed a wrong fill color from visibility off icon. https://fontawesome.com/icons/share-square?style=solid https://material.io/resources/icons/?search=group&icon=group_add&style=baseline https://github.com/owncloud/owncloud-design-system/pull/858 https://github.com/owncloud/owncloud-design-system/pull/864	owncloud/web/packages/design-system/changelog/1.10.0_2020-09-16/add-new-icons/0	{ "file_path": "owncloud/web/packages/design-system/changelog/1.10.0_2020-09-16/add-new-icons", "repo_id": "owncloud", "token_count": 131 }	627
Enhancement: Add margin and padding utility classes We've added utility classes which can assign margin and padding to elements. In their own subsections of utilities section in our design system documentation can be found how to use them. https://github.com/owncloud/owncloud-design-system/pull/890	owncloud/web/packages/design-system/changelog/1.12.0_2020-10-03/utility-classes/0	{ "file_path": "owncloud/web/packages/design-system/changelog/1.12.0_2020-10-03/utility-classes", "repo_id": "owncloud", "token_count": 70 }	628
Enhancement: Added the modal component We've added the modal component together with a basic documentation. https://github.com/owncloud/owncloud-design-system/pull/723	owncloud/web/packages/design-system/changelog/1.3.0_2020-04-23/modal_component/0	{ "file_path": "owncloud/web/packages/design-system/changelog/1.3.0_2020-04-23/modal_component", "repo_id": "owncloud", "token_count": 47 }	629
Enhancement: Use Source Sans Pro We've started using Source Sans Pro in the default theme as the font. https://github.com/owncloud/owncloud-design-system/issues/785 https://github.com/owncloud/owncloud-design-system/pull/791	owncloud/web/packages/design-system/changelog/1.7.0_2020-06-17/oc-ci-font/0	{ "file_path": "owncloud/web/packages/design-system/changelog/1.7.0_2020-06-17/oc-ci-font", "repo_id": "owncloud", "token_count": 67 }	630
Enhancement: Allow hover option in OcTableFiles We've added the possibility to use the `hover` option from OcTable also in OcTableFiles. https://github.com/owncloud/owncloud-design-system/pull/1632 https://github.com/owncloud/owncloud-design-system/pull/1680	owncloud/web/packages/design-system/changelog/11.0.0_2021-10-04/enhancement-hover-for-filestable/0	{ "file_path": "owncloud/web/packages/design-system/changelog/11.0.0_2021-10-04/enhancement-hover-for-filestable", "repo_id": "owncloud", "token_count": 83 }	631
Enhancement: Breadcrumb contextmenu We've added a button to the last item of the OcBreadcrumb component that triggers a dropdown which can be customizably filled. https://github.com/owncloud/web/issues/6030 https://github.com/owncloud/owncloud-design-system/pull/1786	owncloud/web/packages/design-system/changelog/11.3.0_2021-12-03/enhancement-breadcrumb-contextmenu/0	{ "file_path": "owncloud/web/packages/design-system/changelog/11.3.0_2021-12-03/enhancement-breadcrumb-contextmenu", "repo_id": "owncloud", "token_count": 83 }	632
Change: Move OcSidebarNav and OcSidebarNavItem to web We've moved OcSidebarNav and OcSidebarNavItem to web and renamed it to SidebarNav and SidebarNavItem. https://github.com/owncloud/web/issues/6036 https://github.com/owncloud/owncloud-design-system/pull/1810	owncloud/web/packages/design-system/changelog/12.0.0_2022-02-07/change-remove-sidebar-nav/0	{ "file_path": "owncloud/web/packages/design-system/changelog/12.0.0_2022-02-07/change-remove-sidebar-nav", "repo_id": "owncloud", "token_count": 89 }	633
Enhancement: OcTable header alignment We've applied the full row height to the table header and made it vertically centered to give a more fluffy experience for the eye. https://github.com/owncloud/owncloud-design-system/pull/1922	owncloud/web/packages/design-system/changelog/12.0.0_2022-02-07/enhancement-table-header-alignment/0	{ "file_path": "owncloud/web/packages/design-system/changelog/12.0.0_2022-02-07/enhancement-table-header-alignment", "repo_id": "owncloud", "token_count": 60 }	634
Change: Default type of OcButton We've changed the default type of buttons rendered by `OcButton` to `button`. Browsers otherwise assume they are of type `submit` which leads to very unexpected behavior in forms, especially as we use `OcButton` in a lot of (not so obvious) places for a11y reasons. https://github.com/owncloud/owncloud-design-system/pull/2009	owncloud/web/packages/design-system/changelog/13.0.0_2022-03-23/change-ocbutton-default-type/0	{ "file_path": "owncloud/web/packages/design-system/changelog/13.0.0_2022-03-23/change-ocbutton-default-type", "repo_id": "owncloud", "token_count": 100 }	635
Enhancement: Add selection range for OcModal and OcTextInput We've added the possibility to set a selection range for the initial focus selection in OcModal and OcTextinput. https://github.com/owncloud/web/issues/6729 https://github.com/owncloud/owncloud-design-system/pull/2061	owncloud/web/packages/design-system/changelog/13.1.0_2022-06-07/enhancement-add-selection-range-for-modal-and-textinput/0	{ "file_path": "owncloud/web/packages/design-system/changelog/13.1.0_2022-06-07/enhancement-add-selection-range-for-modal-and-textinput", "repo_id": "owncloud", "token_count": 84 }	636