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.

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

File names for test scripts are inconsistent (W) #210

Open
afig opened this issue Jun 6, 2018 · 2 comments
Open

File names for test scripts are inconsistent (W) #210

afig opened this issue Jun 6, 2018 · 2 comments

Comments

@afig
Copy link
Contributor

afig commented Jun 6, 2018

There is an inconsistency on whether test scripts have "add" in their filenames. I would advise that they do not, since the tests are testing the feature's behavior, not necessarily the successful addition of the feature. Additionally, the naming of runAllPrivilegeTests.psql is not consistent with other scripts, something like testPrivileges.psql may be more appropriate. Likewise, the associated README should be renamed. If the privilege test suite is renamed to testPrivileges.psql then the README should be renamed to testPrivilegesREADME.txt.

There are other issues related to the structure and behavior of test files, including #207, but they do not have to be addressed in M3.

Current directory structure of the /tests directory:

├── importStudents
│   ├── README.md
│   └── testBannerRoster.csv
├── privileges
│   ├── 0_setup.sql
│   ├── 1_instructorPass.sql
│   ├── 2_studentPass.sql
│   ├── 3_dbmanagerPass.sql
│   ├── 4_instructorPass2.sql
│   ├── 5_instructorFail.sql
│   ├── 6_studentFail.sql
│   ├── 7_dbmanagerFail.sql
│   ├── 8_cleanup.sql
│   ├── runAllPrivilegeTests.psql
│   └── testPrivilegesREADME.txt
├── testAddConnectionActivityLoggingCleanup.sql
├── testAddConnectionActivityLogging.psql
├── testAddDDLActivityLogging.sql
├── testClassDBRolesMgmt.sql
├── testHelpers.sql
├── testRoleBaseMgmt.sql
└── testUserMgmt.sql
@afig afig added this to the M3 (V 2.x) milestone Jun 6, 2018
@smurthys
Copy link
Member

smurthys commented Jun 7, 2018

I agree with the issue description. I feel a lone README file in any directory can just be called README.

I believe the issue of the "add" prefix has been discussed previously and thus some test scripts do not have that prefix.

@wildtayne
Copy link
Contributor

wildtayne commented Jun 7, 2018

I also agree with @afig's analysis on test script names. Renaming any lone README to README also has the advantage of displaying in the README view below the file list on GitHub.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants