Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Antivirus #5846

Merged
merged 8 commits into from
Mar 23, 2023
Merged

Antivirus #5846

merged 8 commits into from
Mar 23, 2023

Conversation

kobergj
Copy link
Collaborator

@kobergj kobergj commented Mar 15, 2023

Backports antivirus from experimental

@update-docs
Copy link

update-docs bot commented Mar 15, 2023

Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would create a changelog item based on your changes.

@kobergj
Copy link
Collaborator Author

kobergj commented Mar 16, 2023 •
edited

New service checklist:

  • Provide a readme.md for that service
    Use CamelCase for section headers.
  • If a new CLI command(s) is introduced, that command must be described in the readme.
  • Add the service to the makefile in the ocis repo root
  • Make the service startable for binary and individual startup
    • For single binary add service to ocis/pkg/runtime
    • For individual startup add service to ocis/pkg/commands
  • Add the service to .drone.star to enable ci
  • Make the service appear in owncloud.dev by creating a docs/services/{service} folder and adding at least
    • an _index.md that describes the service using a specific header content that you can derive eg from the _index.md file of the idm service. Remember to adapt the service name.
    • For the content, use the text from the readme.me if you do not want to deviate, though you can write something different.
      (Note that I have atm no clue how this works when embedding images)
    • a configuration.md that pulls in the autogenerated config
  • Inform doc team in an early stage to review the readme AND the environment variables created.
    (the description must reflect the behaviour AND usually has a positive code quality impact)
  • Create proper description strings for envvars - see other services for examples, especially when it comes to multiple values
    (base description, set of available values, description of each value)
  • When suggestable commits are created for text changes and you agree, collect them to a batch and commit them. Do not forget to rebase locally to avoid overwriting the changes made.
  • If new envvars are introduced which serve the same purpose but in multiple services, an additional envvar must be added at the beginning of the list starting with OCIS_ (global envvar).
  • Ensure that a service has a debug port
    (see issue: Ensure all services have a debug port #5712)
  • If the new service introduces a new port for its use, the port must be added to port-ranges.md and to the readme.md / _index.md file.
  • Make sure to have a function FullDefaultConfig() in pkg/config/defaults/defaultconfig.go of your service. It is needed to create the documentation
  • ...

@kobergj kobergj force-pushed the Antivirus branch 2 times, most recently from e5d7c5d to cedb0a4 Compare March 16, 2023 16:09
@mmattel mmattel mentioned this pull request Mar 16, 2023
Closed
@kobergj kobergj force-pushed the Antivirus branch 4 times, most recently from 5562ab7 to ff819c1 Compare March 17, 2023 15:14
kobergj and others added 4 commits March 21, 2023 10:04
@kobergj
backport antivirus from experimental
f4ba4e0 
Signed-off-by: jkoberg <jkoberg@owncloud.com>
@kobergj
service checklist
c550390 
Signed-off-by: jkoberg <jkoberg@owncloud.com>
@kobergj @mmattel
improve antivirus documentation
fc4ba49 
Co-authored-by: Martin <github@diemattels.at>
@kobergj
notification for virusscan
642d8f0 
Signed-off-by: jkoberg <jkoberg@owncloud.com>
@kobergj kobergj force-pushed the Antivirus branch 2 times, most recently from 20d29f9 to fb9854a Compare March 21, 2023 09:48
@kobergj
bump reva
d8e31fe 
Signed-off-by: jkoberg <jkoberg@owncloud.com>
@kobergj kobergj marked this pull request as ready for review March 21, 2023 10:45
@mmattel mmattel mentioned this pull request Mar 21, 2023
Merged
butonic
butonic requested changes Mar 22, 2023
View reviewed changes
docs/services/antivirus/_index.md Outdated Show resolved Hide resolved
docs/services/antivirus/_index.md Outdated Show resolved Hide resolved
docs/services/antivirus/_index.md Outdated Show resolved Hide resolved
docs/services/antivirus/_index.md Outdated Show resolved Hide resolved
docs/services/antivirus/_index.md Outdated Show resolved Hide resolved
services/antivirus/pkg/config/config.go Outdated Show resolved Hide resolved
services/antivirus/pkg/config/config.go Outdated Show resolved Hide resolved
services/userlog/pkg/service/conversion.go Outdated Show resolved Hide resolved
services/userlog/pkg/service/conversion.go Outdated Show resolved Hide resolved
services/userlog/pkg/service/service.go
continue
}

// TODO: should space mangers also be informed?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

who do you need to discuss and decide that?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just another opinion than my own

@mmattel
Copy link
Contributor

mmattel commented Mar 22, 2023 •
edited

Info: some of the text suggestions were alread in the refrenced admin docs pr, but not all - fixed.
Thanks for catching 👍

kobergj and others added 2 commits March 22, 2023 13:50
@kobergj @butonic
improve antivirus documentation
6c00708 
Co-authored-by: Jörn Friedrich Dreyer <jfd@butonic.de>
@kobergj
move debughandlers to their own package
8698044 
Signed-off-by: jkoberg <jkoberg@owncloud.com>
@mmattel mmattel mentioned this pull request Mar 22, 2023
Closed
@kobergj kobergj requested a review from butonic March 22, 2023 13:01
@kobergj
abort processing when virus scan errord
81d1521 
Signed-off-by: jkoberg <jkoberg@owncloud.com>
@kobergj kobergj requested a review from butonic March 22, 2023 16:39
@ownclouders
Copy link
Contributor

ownclouders commented Mar 22, 2023 •
edited

E2E tests failed: https://drone.owncloud.com/owncloud/ocis/20721/67/1

💥 To see the trace, please open the link in the console ...

npx playwright show-trace https://cache.owncloud.com/public/owncloud/ocis/20721/tracing/unstructured-collection-of-testable-space-interactions-alice-2023-3-23-08-20-01.zip

npx playwright show-trace https://cache.owncloud.com/public/owncloud/ocis/20721/tracing/unstructured-collection-of-testable-space-interactions-anonymous-2023-3-23-08-20-57.zip

npx playwright show-trace https://cache.owncloud.com/public/owncloud/ocis/20721/tracing/unstructured-collection-of-testable-space-interactions-brian-2023-3-23-08-20-59.zip

npx playwright show-trace https://cache.owncloud.com/public/owncloud/ocis/20721/tracing/users-can-navigate-web-via-tiles-alice-2023-3-23-08-22-38.zip

@sonarcloud
Copy link

sonarcloud bot commented Mar 23, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 8 Code Smells

0.5% 0.5% Coverage
0.0% 0.0% Duplication

@kobergj kobergj merged commit 8e5fcf8 into owncloud:master Mar 23, 2023
@kobergj kobergj deleted the Antivirus branch March 23, 2023 09:04
ownclouders pushed a commit that referenced this pull request Mar 23, 2023
@kobergj
Merge pull request #5846 from kobergj/Antivirus
87b14fa 
Antivirus
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mmattel mmattel mmattel left review comments

@butonic butonic butonic approved these changes

@wkloucek wkloucek Awaiting requested review from wkloucek wkloucek is a code owner

@micbar micbar Awaiting requested review from micbar micbar is a code owner

@phil-davis phil-davis Awaiting requested review from phil-davis phil-davis is a code owner

@individual-it individual-it Awaiting requested review from individual-it individual-it is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@kobergj @mmattel @ownclouders @butonic