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

[Task] adding a version control for excel file and the regression testing for a excel file #2283

Open
wants to merge 7 commits into
base: devel
Choose a base branch
from

Conversation

wenchichenginl
Copy link
Collaborator


Pull Request Description

What issue does this change request address? (Use "#" before the issue to link it, i.e., #42.)

#2278

What are the significant changes in functionality due to this change request?

Two python codes should be generated to deal with this issue. The first code is to diff the excel files and the second code is to test the excel if the formula is messed up.


For Change Control Board: Change Request Review

The following review must be completed by an authorized member of the Change Control Board.

  • 1. Review all computer code.
  • 2. If any changes occur to the input syntax, there must be an accompanying change to the user manual and xsd schema. If the input syntax change deprecates existing input files, a conversion script needs to be added (see Conversion Scripts).
  • 3. Make sure the Python code and commenting standards are respected (camelBack, etc.) - See on the wiki for details.
  • 4. Automated Tests should pass, including run_tests, pylint, manual building and xsd tests. If there are changes to Simulation.py or JobHandler.py the qsub tests must pass.
  • 5. If significant functionality is added, there must be tests added to check this. Tests should cover all possible options. Multiple short tests are preferred over one large test. If new development on the internal JobHandler parallel system is performed, a cluster test must be added setting, in XML block, the node <internalParallel> to True.
  • 6. If the change modifies or adds a requirement or a requirement based test case, the Change Control Board's Chair or designee also needs to approve the change. The requirements and the requirements test shall be in sync.
  • 7. The merge request must reference an issue. If the issue is closed, the issue close checklist shall be done.
  • 8. If an analytic test is changed/added is the the analytic documentation updated/added?
  • 9. If any test used as a basis for documentation examples (currently found in raven/tests/framework/user_guide and raven/docs/workshop) have been changed, the associated documentation must be reviewed and assured the text matches the example.

@PaulTalbot-INL
Copy link
Collaborator

Thanks for the submission!

The Python files contributed need to conform to the RAVEN style standard, which can be found here: https://github.com/idaholab/raven/wiki/RAVEN-Code-Standards

1. Change the location of the python file (Excel_diff.py) to the ./Scripts

2.Copy the necessary path to the ".gitattributes" and "config" file and remove the .gitattributes under "D_01_Excel_Version_Control_Tool"

3. Tested the version control tool under raven git repository.

4. Change the format of the Excel_diff.py to meet the requirements
Copy link
Collaborator

@PaulTalbot-INL PaulTalbot-INL left a comment

Choose a reason for hiding this comment

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

A few more minor changes

scripts/Excel_diff.py Outdated Show resolved Hide resolved
scripts/Excel_diff.py Outdated Show resolved Hide resolved
scripts/Excel_diff.py Outdated Show resolved Hide resolved
scripts/Excel_diff.py Show resolved Hide resolved
scripts/Excel_diff.py Outdated Show resolved Hide resolved
scripts/Excel_diff.py Outdated Show resolved Hide resolved
Address all the comments from Paul for "A few more minor changes". All the codes are tested before committing it through git.
Forgot to save the python file. This is the updated version after incorporating all the changes.
Copy link
Collaborator

@PaulTalbot-INL PaulTalbot-INL left a comment

Choose a reason for hiding this comment

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

Two file location comments to consider; I need to look at the tests once they run, as well.

@@ -0,0 +1,13 @@
[Inputs]
Copy link
Collaborator

Choose a reason for hiding this comment

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

This file seems to be in the base level of RAVEN, but should it be?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I am okay based on Dylan's description of the diffing script's location, but I still believe this one is probably not in the right location.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I removed this file and in the process of testing the best location on putting the outputs. I am thinking executing the diff through alias and put the output in the same folder but not sure if that will work for a custom diff.

@@ -0,0 +1,62 @@
import os
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should this be in raven/tests/scripts/TestHarness/testers?

Copy link
Collaborator

Choose a reason for hiding this comment

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

@PaulTalbot-INL since it's a general script for use outside of the testing harness, I instructed @wenchichenginl to put it in raven/scripts/ but let me know if you think it should only live within the testing harness.

@PaulTalbot-INL
Copy link
Collaborator

Looking at the tests that run, it looks like most of the machines are skipping the excel test due to not having xlwings; do any of the machines have the library so that we test this?

@moosebuild
Copy link

Job Mingw Test on df8d6db : invalidated by @PaulTalbot-INL

Re-trying RAY internal parallel test

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

Successfully merging this pull request may close these issues.

5 participants