reva

module
v2.19.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 5, 2024 License: Apache-2.0

README

License GoDoc Gitter chat Build Status Go Report Card codecov FOSSA Status

REVA Logo

REVA is an interoperability platform. It connects storage, sync and share platforms and application providers, and it does it in a vendor and platform neutral way by using the CS3 APIS.

Installation

Head to Documentation for documentation or download to get the latest available release.

Documentation & Support

Read the getting started guide and the other feature guides.

Build and run it yourself

You need to have Go (version 1.16 or higher), git and make installed. Some of these commands may require sudo, depending on your system setup.

$ git clone https://github.com/cs3org/reva
$ cd reva
$ make deps
$ make build
$ mkdir -p /etc/revad
$ cp examples/storage-references/users.demo.json /etc/revad/users.json
$ cp examples/storage-references/groups.demo.json /etc/revad/groups.json
$ cp examples/storage-references/providers.demo.json /etc/revad/ocm-providers.json
$ cmd/revad/revad -dev-dir examples/storage-references

You can also read the build from sources guide and the setup tutorial.

Run tests

Reva's codebase continuously undergoes testing at various levels.

To understand which tests exist, you can have a look at the Makefile and the Drone run logs.

The tests run by CERN's instance of Drone CI/CD are defined in the .drone.star file.

NB: The tests/oc-integration-tests/drone and tests/oc-integration-tests/local folders contain the configuration fixtures that are used to start up the Reva instance to test (on drone CI/CD or on your local system, respectively), for both these acceptance tests ("ownCloud legacy integration tests") and the Litmus tests.

Unit tests

This runs the <unit>_test.go files that appear next to some of the <unit>.go files in the code tree.

For instance pkg/utils/utils_test.go contains unit tests for pkg/utils/utils.go.

To run all of them you can do make test.

If you see TestGetManagerWithInvalidUser/Nil_in_user fail, try removing /etc/revad/users.json on your system.

To run a single one of them you can do:

$ go test `go list ./pkg/utils/...`
ok  	github.com/cs3org/reva/v2/pkg/utils	0.374s
Integration tests (GRPC)

See tests/integration. This requires Redis.

export REDIS_ADDRESS=127.0.0.1:6379
make test-integration

You can get more verbose output with ginkgo -v -r tests/integration/.

NB: This will work better on Linux than on MacOS because of issues with static linking (library not found for -lcrt0.o).

Litmus tests (WebDAV)

Litmus is a webdav test suite. The litmus tests for Reva's WebDAV interface are run using the ownCloud's litmus Docker image. The '-old' and '-new' refer to which LITMUS_URL environment variable is passed to that Docker image, in other words, which path on the Reva server the litmus tests are run against.

  1. start the needed services

    mkdir -p /var/tmp/reva/einstein
    cd tests/oc-integration-tests/local
    ../../../cmd/revad/revad -c frontend.toml &
    ../../../cmd/revad/revad -c gateway.toml &
    ../../../cmd/revad/revad -c storage-home.toml &
    ../../../cmd/revad/revad -c storage-users.toml &
    ../../../cmd/revad/revad -c users.toml
    
  2. run litmus tests:

    docker run --rm --network=host\
        -e LITMUS_URL=http://localhost:20080/remote.php/webdav \
        -e LITMUS_USERNAME=einstein \
        -e LITMUS_PASSWORD=relativity \
        owncloud/litmus:latest
    
    • add TESTS env. variable to test only a subset of tests e.g -e TESTS="basic http copymove props"
    • change LITMUS_URL for other tests e.g. -e LITMUS_URL=http://localhost:20080/remote.php/dav/files/einstein or to a public-share link
    • if on MacOS you see FAIL (connection refused by '127.0.0.1' port 20080: Connection refused), it may be necessary to replace 'localhost' with your host IP address (e.g. ipconfig getifaddr en0 or sudo ifconfig | grep 192)
Acceptance tests (ownCloud legacy)

See tests/acceptance.

This will require some PHP-related tools to run, for instance on Ubuntu you will need apt install -y php-xml php-curl composer.

  1. start an LDAP server

    docker run --rm --hostname ldap.my-company.com \
        -e LDAP_TLS_VERIFY_CLIENT=never \
        -e LDAP_DOMAIN=owncloud.com \
        -e LDAP_ORGANISATION=ownCloud \
        -e LDAP_ADMIN_PASSWORD=admin \
        --name docker-slapd \
        -p 127.0.0.1:389:389 \
        -p 636:636 -d osixia/openldap:1.3.0
    
  2. start the needed services

    cd tests/oc-integration-tests/local
    ../../../cmd/revad/revad -c frontend.toml &
    ../../../cmd/revad/revad -c gateway.toml &
    ../../../cmd/revad/revad -c shares.toml &
    ../../../cmd/revad/revad -c storage-shares.toml &
    ../../../cmd/revad/revad -c storage-home.toml &
    ../../../cmd/revad/revad -c storage-users.toml &
    ../../../cmd/revad/revad -c storage-publiclink.toml &
    ../../../cmd/revad/revad -c machine-auth.toml &
    ../../../cmd/revad/revad -c permissions-ocis-ci.toml &
    ../../../cmd/revad/revad -c ldap-users.toml
    
  3. clone ownCloud Infinite Scale OCIS

    git clone https://github.com/owncloud/ocis.git ./testrunner
    
  4. to run the correct version of the testsuite check out the commit id from the .drone.env file

  5. clone the testing app

    git clone https://github.com/owncloud/testing.git ./testrunner/apps/testing
    
  6. run the tests

    cd testrunner
    TEST_SERVER_URL='http://localhost:20080' \
    OCIS_REVA_DATA_ROOT='/var/tmp/reva/' \
    DELETE_USER_DATA_CMD="rm -rf /var/tmp/reva/data/nodes/root/* /var/tmp/reva/data/nodes/*-*-*-* /var/tmp/reva/data/blobs/*" \
    SKELETON_DIR='./apps/testing/data/apiSkeleton' \
    TEST_WITH_LDAP='true' \
    REVA_LDAP_HOSTNAME='localhost' \
    TEST_REVA='true' \
    BEHAT_FILTER_TAGS='~@notToImplementOnOCIS&&~@toImplementOnOCIS&&~comments-app-required&&~@federation-app-required&&~@notifications-app-required&&~systemtags-app-required&&~@provisioning_api-app-required&&~@preview-extension-required&&~@local_storage&&~@skipOnOcis-OCIS-Storage&&~@skipOnOcis' \
    EXPECTED_FAILURES_FILE=../reva/tests/acceptance/expected-failures-on-OCIS-storage.md \
    make test-acceptance-from-core-api
    

    This will run all tests that are relevant to reva.

    To run a single test add BEHAT_FEATURE=<feature file> and specify the path to the feature file and an optional line number. For example: BEHAT_FEATURE='tests/acceptance/features/apiWebdavUpload1/uploadFile.feature:12'

    Make sure to double check the paths if you are changing the OCIS_REVA_DATA_ROOT. The DELETE_USER_DATA_CMD needs to clean up the correct folders.

Daily releases

On every commit on the master branch (including merged Pull Requests) a new release will be created and available at daily releases.

Major versions

There are currently two major versions in active development.

1.x versions

The master branch is the stable development branch. Releases from master are tagged as 1.x.x versions following semver.

2.x versions

The edge branch is used to develop the next version of this project. The edge branch is based on a new concept named "Spaces" and a new set of the CS3APIs are being implemented, making it not compatible with master branch. Releases from edge are tagged as 2.x.x versions following semver.

Run it using Docker

See https://hub.docker.com/r/cs3org/reva.

Plugin development

Checkout the Tutorials.

License

To promote free and unrestricted adoption of CS3 APIs and the reference implementation REVA by all EFSS implementations and all platforms and application providers, both community and commercial, Open Source and Open Core, CERN released the source code repositories under Apache 2.0 license.

Further evolution of the CS3 APIs will be driven by the needs of the Educational and Research community with the goal of maximizing the portability of the applications and service extensions.

REVA is distributed under Apache 2.0 license.

REVA logo's have been designed and contributed to the project by Eamon Maguire.

Disclaimer

There is no backward compatibility promises and semantic versioning yet. Semantic versioning will be added once v1.0.0 is reached.

If you want to use it, vendor it. It is always OK to change things to make things better. The API is not 100% correct in the first commit.

Directories

Path Synopsis
cmd
examples
sdk
internal
grpc/services/publicstorageprovider
Package publicstorageprovider provides a CS3 storageprovider implementation for public links.
Package publicstorageprovider provides a CS3 storageprovider implementation for public links.
http/interceptors/appctx
Package appctx creates a context with useful components attached to the context like loggers and token managers.
Package appctx creates a context with useful components attached to the context like loggers and token managers.
pkg
app
auth/manager/nextcloud
Package nextcloud verifies a clientID and clientSecret against a Nextcloud backend.
Package nextcloud verifies a clientID and clientSecret against a Nextcloud backend.
auth/manager/oidc
Package oidc verifies an OIDC token against the configured OIDC provider and obtains the necessary claims to obtain user information.
Package oidc verifies an OIDC token against the configured OIDC provider and obtains the necessary claims to obtain user information.
bytesize
Package bytesize provides easy conversions from human readable strings (eg.
Package bytesize provides easy conversions from human readable strings (eg.
conversions
Package conversions sits between CS3 type definitions and OCS API Responses
Package conversions sits between CS3 type definitions and OCS API Responses
ctx
errtypes
Package errtypes contains definitions for common errors.
Package errtypes contains definitions for common errors.
events/example/consumer
Package consumer contains an example implementation of an event consumer
Package consumer contains an example implementation of an event consumer
events/example/publisher
Package publisher contains an example implementation for a publisher
Package publisher contains an example implementation for a publisher
events/stream
Package stream provides streaming clients used by `Consume` and `Publish` methods
Package stream provides streaming clients used by `Consume` and `Publish` methods
ocm/share/repository/nextcloud
Package nextcloud verifies a clientID and clientSecret against a Nextcloud backend.
Package nextcloud verifies a clientID and clientSecret against a Nextcloud backend.
publicshare/manager/owncloudsql
Package owncloudsql implements a publiclink share manager backed by an existing ownCloud 10 database
Package owncloudsql implements a publiclink share manager backed by an existing ownCloud 10 database
rgrpc/status
Package status contains helpers functions to create grpc Status with contextual information, like traces.
Package status contains helpers functions to create grpc Status with contextual information, like traces.
rhttp/datatx
Package datatx provides a library to abstract the complexity of using various data transfer protocols.
Package datatx provides a library to abstract the complexity of using various data transfer protocols.
rhttp/datatx/metrics
Package metrics provides prometheus metrics for the data managers..
Package metrics provides prometheus metrics for the data managers..
rhttp/datatx/utils/download
Package download provides a library to handle file download requests.
Package download provides a library to handle file download requests.
sdk
storage/utils/indexer
Package indexer provides symlink-based indexer for on-disk document-directories.
Package indexer provides symlink-based indexer for on-disk document-directories.
storage/utils/templates
Package templates contains data-driven templates for path layouts.
Package templates contains data-driven templates for path layouts.
tests
tools

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL