Skip to content

CONTRIBUTIONS.md contains stale / misleading information #1253

Open
@System-Arch

Description

@System-Arch

Describe the bug

The information in CONTRIBUTIONS.md is stale and/or misleading. Here are several examples of guidance that seem to be in need of revisions:

  1. In the Testing section, it states:

    "Currently, acceptance tests require an access key and don't support basic authentication or an API key. To generate an access key, please refer to the official documentation

    The use of the term "access key" (used twice) in this text is confusing as it appears to be referring to Access Tokens (not keys).

  2. In the Testing section, it states:

    ...you have to set some environment variables as this is how the acceptance tests pick up their config.

    ARTIFACTORY_URL=http://localhost:8082
    ARTIFACTORY_USERNAME=admin
    ARTIFACTORY_ACCESS_TOKEN=<your_access_token>
    TF_ACC=true
    

    It appears to be insufficient (and, in fact, unnecessary) to set ARTIFACTORY_URL and ARTIFACTORY_ACCESS_TOKEN. Instead, JFROG_URL and JFROG_ACCESS_TOKEN seem to be the environment variables needed in order to run tests (at least with newer versions of the JFrog Platform)

  3. In the Testing section, there is no mention of the need to configure RSA key pairs as described in https://jfrog.com/help/r/jfrog-artifactory-documentation/setting-up-rsa-key-pairs, which results in confusing error messages when trying to run the tests in a development sandbox. More specifically, it would be helpful if the documentation included the following instructions

    openssl genrsa -traditional -out private-key.pem 2048
    openssl rsa -in private-key.pem -outform PEM -pubout -out private-key.pem.pub
    
    export JFROG_TEST_RSA_PRIVATE_KEY=$(<private-key.pem)
    export JFROG_TEST_RSA_PUBLIC_KEY=$(<private-key.pem.pub)
    
    export JFROG_TEST_PGP_PRIVATE_KEY=$(<private-key.pem)
    export JFROG_TEST_PGP_PUBLIC_KEY=$(<private-key.pem.pub)
    

Expected behavior
Clear and concise documentation on how to develop and test changes to this provider.

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions