Semantic Versioning and CLI --version support #51

bemcdonnell · 2017-06-22T03:23:57Z

No description provided.

bemcdonnell · 2017-06-22T03:31:24Z

Addresses Issue #39 (Going to address #41 next)

bemcdonnell · 2017-06-22T03:32:46Z

One improvement - now we don't have to update the version in several places...

dickinsonre · 2017-06-22T12:55:08Z

@bemcdonnell as long as you are mentioning versioning - it would help as well to have the actual inp file have the engine version in the OPTIONS section. I often get past SWMM5 files and it is hard to figure out what version it matches. It would help parse the INP better - especially those predating SWMM 5.0.013

bemcdonnell · 2017-06-22T12:56:41Z

@dickinsonre so are you suggesting we restrict an INP file to run with a specific version of SWMM?

dickinsonre · 2017-06-22T13:08:55Z

No, of course not but as i was reading all of the discussion of internal vs external parsing i remembered parsing issues with groundwater and a few other odd sections where a blank, a "*" or the number of tokens per line change the way the SWMM 5 engine builds the data structure. I hope this is clearer, but if you often get inp files from Korea or Vietnam (not to pick on those countries) it would be nice to know what version created the files.

bemcdonnell · 2017-06-22T13:20:47Z

@dickinsonre: So essentially, which version of SWMM were we using when we "saved" the inp file?

goanpeca · 2017-06-22T14:23:54Z

src/consts.h

-#define   VERSION            51011                                             //(5.1.011)
+// Update VERSION and SEMVERSION Simultaneously 
+#define   VERSION            51013          // Eventually will be deprecated. 
+#define   SEMVERSION         "5.1.13.dev0"  // Semantic Version


Actually I think it is more like

5.1.13dev0

We could store this as struct with major, minor, patch ?

struct VERSION_INFO { char major[3]; char minor[3]; char patch[10]; };

Or something and generate VERSION and SEMVERSION from this with some helper funcs?

@goanpeca good suggestion - yes I can do that. Maybe patch should be longer since perhaps we might be adding some git vers numbers to it.

Sure, it can be, don't know how long though :-p

@goanpeca, I think splitting these up into major minor and patch is good but I'm not sure that containing this into a struct is necessary.

I am happy to change the function to have three outputs:

int DLLEXPORT swmm_getSemVersion(char* major, char* minor, char* patch)

It leaves the user with more options.

The more I think about it, I think simply outputting the char array is the cleanest way.

bemcdonnell · 2017-07-05T23:50:24Z

Here's the scoop:

You can now run:

swmm --help
swmm -h
swmm --version
swmm -v

Which gives:


STORMWATER MANAGEMENT MODEL (SWMM5) HELP

COMMANDS:
        --help (-h)       Help Docs
        --version (-v)    Build Version

RUNNING A SIMULATION:
        swmm5 <input file> <report file> <output file>

goanpeca · 2017-07-05T23:54:15Z

Looks good :-)

michaeltryby

Since you are in here you might as well go ahead and separate main() from swmm5.c similar to what was done over in the EPANET repo. This way the dll and exe are two separate build targets and the exe can use the dll. Make sense?

michaeltryby · 2017-07-06T14:54:04Z

src/swmm5.c

+{
+	strcpy(major, SEMVERSION_MAJOR);
+	strcpy(minor, SEMVERSION_MINOR);
+	strcpy(patch, SEMVERSION_PATCH);


Use secure string copy strcpy_s() here instead.

michaeltryby · 2017-07-06T14:57:33Z

src/swmm5.c

+	strcat(semver, SEMVERSION_MINOR);
+	strcat(semver, ".");
+	strcat(semver, SEMVERSION_PATCH);
+}


This should be done in one line using a secure formatted print to string sprintf_s().

michaeltryby · 2017-07-06T15:14:55Z

src/text.h


 #define FMT03 " There are errors.\n"
 #define FMT04 " There are warnings.\n"
 #define FMT05 "\n"
 #define FMT06 "\n o  Retrieving project data"
 #define FMT07 "\n o  Writing output report"
-#define FMT08 \
-  "\n  EPA STORM WATER MANAGEMENT MODEL - VERSION 5.1 (Build 5.1.012)"         //(5.1.012)
+


Are we sure about all the places FMT08 is being used?

goanpeca · 2017-07-06T15:22:54Z

Since you are in here you might as well go ahead and separate main() from swmm5.c similar to what was done over in the EPANET repo. This way the dll and exe are two separate build targets and the exe can use the dll. Make sense?

Yes it makes sense 👍 !

michaeltryby · 2017-07-06T15:48:15Z

@goanpeca I see it fitting in here, but I think @bemcdonnell wants to handle separating main() in a separate pull.

goanpeca · 2017-07-06T16:16:05Z

@goanpeca I see it fitting in here, but I think @bemcdonnell wants to handle separating main() in a separate pull.

Sure, it also works!

Update dynwave.c

bemcdonnell added 2 commits June 21, 2017 23:20

added API Semantic Version getter

3b63de7

Cleaning

14d669d

bemcdonnell added the type:enhancement label Jun 22, 2017

bemcdonnell added this to the v5.1.13 milestone Jun 22, 2017

bemcdonnell changed the title ~~Semversion~~ Semantic Versioning and CLI --version support Jun 22, 2017

bemcdonnell self-assigned this Jun 22, 2017

goanpeca reviewed Jun 22, 2017

View reviewed changes

bemcdonnell added 2 commits June 28, 2017 21:26

Updated Semantic Version and added swmm_getVersionInfo

ce5ea35

Added Command Line Arguments

29efeb2

goanpeca approved these changes Jul 5, 2017

View reviewed changes

bemcdonnell requested a review from michaeltryby July 5, 2017 23:51

michaeltryby suggested changes Jul 6, 2017

View reviewed changes

Added secure string functions

9a09928

bemcdonnell merged commit 759a9ed into pyswmm:dev Jul 6, 2017

bemcdonnell deleted the semversion branch July 6, 2017 21:38

bemcdonnell added the reso:completed label Oct 21, 2018

bemcdonnell modified the milestones: v5.1.13, v5.2.0.dev4 Oct 21, 2018

michaeltryby added a commit to SWMM-Project/swmm-solver that referenced this pull request Aug 21, 2020

Merge pull request pyswmm#51 from LRossman/patch-4

293d8b7

Update dynwave.c

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Semantic Versioning and CLI --version support #51

Semantic Versioning and CLI --version support #51

bemcdonnell commented Jun 22, 2017

bemcdonnell commented Jun 22, 2017

bemcdonnell commented Jun 22, 2017

dickinsonre commented Jun 22, 2017

bemcdonnell commented Jun 22, 2017

dickinsonre commented Jun 22, 2017

bemcdonnell commented Jun 22, 2017

goanpeca Jun 22, 2017 •

edited

Loading

bemcdonnell Jun 22, 2017

goanpeca Jun 22, 2017

bemcdonnell Jun 26, 2017

bemcdonnell Jun 26, 2017 •

edited

Loading

bemcdonnell Jun 26, 2017

bemcdonnell commented Jul 5, 2017

goanpeca commented Jul 5, 2017

michaeltryby left a comment

michaeltryby Jul 6, 2017

michaeltryby Jul 6, 2017

michaeltryby Jul 6, 2017

bemcdonnell Jul 6, 2017

goanpeca commented Jul 6, 2017

michaeltryby commented Jul 6, 2017 •

edited

Loading

goanpeca commented Jul 6, 2017

Semantic Versioning and CLI --version support #51

Semantic Versioning and CLI --version support #51

Conversation

bemcdonnell commented Jun 22, 2017

bemcdonnell commented Jun 22, 2017

bemcdonnell commented Jun 22, 2017

dickinsonre commented Jun 22, 2017

bemcdonnell commented Jun 22, 2017

dickinsonre commented Jun 22, 2017

bemcdonnell commented Jun 22, 2017

goanpeca Jun 22, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bemcdonnell Jun 26, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bemcdonnell commented Jul 5, 2017

goanpeca commented Jul 5, 2017

michaeltryby left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

goanpeca commented Jul 6, 2017

michaeltryby commented Jul 6, 2017 • edited Loading

goanpeca commented Jul 6, 2017

goanpeca Jun 22, 2017 •

edited

Loading

bemcdonnell Jun 26, 2017 •

edited

Loading

michaeltryby commented Jul 6, 2017 •

edited

Loading