Updated README

Author: jeetchoudhary

README.md

@@ -142,8 +142,9 @@ named arguments:
                          Only update image tag store. Skip creating PRs
   -x X                   comment snippet mentioned in line just before FROM instruction for ignoring a child image. Defaults to 'no-dfiu'
   -r, --rate-limit-pr-creations 
-                         Enable rateLimiting for throttling the number of PRs DFIU will cut over a period of time.
-                         Defaults is not set, means no ratelimiting is imposed if this is not set to true
+                         Enable rateLimiting for throttling the number of PRs DFIU will cut over a period of time. 
+                         The argument value should be in format "<positive_integer>-<ISO-8601_formatted_time>". For example "--rate-limit-pr-creations 60-PT1H" to create 60 PRs per hour.
+                         Default is not set, this means no ratelimiting is imposed.
                          
 subcommands:
   Specify which feature to perform

dockerfile-image-update/src/main/java/com/salesforce/dockerfileimageupdate/utils/DockerfileGitHubUtil.java

@@ -363,6 +363,8 @@ public void createPullReq(GHRepository origRepo,
                               RateLimiter rateLimiter) throws InterruptedException, IOException {
         // TODO: This may loop forever in the event of constant -1 pullRequestExitCodes...
         while (true) {
+            // TODO: accept rateLimiter Optional with option to get no-op rateLimiter
+            // where it's not required.
             if(rateLimiter != null) {
                 log.info("Trying to consume a token before creating pull request..");
                 // Consume a token from the token bucket.

dockerfile-image-update/src/test/java/com/salesforce/dockerfileimageupdate/subcommands/impl/AllTest.java

@@ -36,7 +36,7 @@ public void testAllCommandSuccessful() throws Exception {
         Map<String, Object> nsMap = ImmutableMap.of(Constants.IMG,
                 "image", Constants.TAG,
                 "tag", Constants.STORE,
-                "store", RATE_LIMIT_PR_CREATION, "500-per-60s");
+                "store");
 
         Namespace ns = new Namespace(nsMap);
         RateLimiter rateLimiter = spy(new RateLimiter());
@@ -85,7 +85,7 @@ public void testAllCommandSkipsSendingPRsIfSearchReturnsEmpty() throws Exception
         Map<String, Object> nsMap = ImmutableMap.of(Constants.IMG,
                 "image", Constants.TAG,
                 "tag", Constants.STORE,
-                "store", RATE_LIMIT_PR_CREATION, "500-per-60s");
+                "store");
 
         Namespace ns = new Namespace(nsMap);
         All all = spy(new All());

dockerfile-image-update/src/test/java/com/salesforce/dockerfileimageupdate/subcommands/impl/ChildTest.java

@@ -35,14 +35,12 @@ public Object[][] inputMap() {
                         GIT_REPO, "test",
                         IMG, "test",
                         FORCE_TAG, "test",
-                        STORE, "test",
-                        RATE_LIMIT_PR_CREATION, "500-per-60s")},
+                        STORE, "test")},
                 {ImmutableMap.of(
                         GIT_REPO, "test",
                         IMG, "test",
                         FORCE_TAG, "test",
-                        STORE, "test",
-                        RATE_LIMIT_PR_CREATION, "500-per-60s")},
+                        STORE, "test")},
         };
     }
 

dockerfile-image-update/src/test/java/com/salesforce/dockerfileimageupdate/subcommands/impl/ParentTest.java

@@ -125,7 +125,7 @@ public void testParentCommandSuccessfulForS3ImageStore() throws Exception {
                 "image", Constants.TAG,
                 "tag", Constants.STORE,
                 "s3://store", Constants.SKIP_PR_CREATION,
-                false, RATE_LIMIT_PR_CREATION, "500-per-60s");
+                false);
         Namespace ns = new Namespace(nsMap);
         Parent parent = spy(new Parent());
         DockerfileGitHubUtil dockerfileGitHubUtil = mock(DockerfileGitHubUtil.class);