Re: [tor-bugs] #20546 [Metrics/CollecTor]: Implement CleanUtils class for common file system operations

[Tor Bug Tracker & Wiki]

#20546: Implement CleanUtils class for common file system operations
+--
 Reporter:  iwakeh  |  Owner:  metrics-team
 Type:  enhancement | Status:  assigned
 Priority:  Medium  |  Milestone:
Component:  Metrics/CollecTor   |Version:
 Severity:  Normal  | Resolution:
 Keywords:  metrics-help, metrics-2018  |  Actual Points:
Parent ID:  #20518  | Points:
 Reviewer:  |Sponsor:
+--
Changes (by irl):

 * cc: Samdney (added)
 * owner:  Samdney => metrics-team


Comment:

 No activity from Samdney in 11 months on this ticket. Re-assigning to
 metrics-team.

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #20546 [Metrics/CollecTor]: Implement CleanUtils class for common file system operations (was: implement CleanUtils)

[Tor Bug Tracker & Wiki]

#20546: Implement CleanUtils class for common file system operations
---+--
 Reporter:  iwakeh |  Owner:  Samdney
 Type:  enhancement| Status:  assigned
 Priority:  Medium |  Milestone:
Component:  Metrics/CollecTor  |Version:
 Severity:  Normal | Resolution:
 Keywords:  metrics-help   |  Actual Points:
Parent ID:  #20518 | Points:
 Reviewer: |Sponsor:
---+--

Comment (by karsten):

 Let the summary reveal a bit more what this ticket is about.

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #20546 [Metrics/CollecTor]: implement CleanUtils

[Tor Bug Tracker & Wiki]

#20546: implement CleanUtils
---+--
 Reporter:  iwakeh |  Owner:  Samdney
 Type:  enhancement| Status:  assigned
 Priority:  Medium |  Milestone:
Component:  Metrics/CollecTor  |Version:
 Severity:  Normal | Resolution:
 Keywords:  metrics-help   |  Actual Points:
Parent ID:  #20518 | Points:
 Reviewer: |Sponsor:
---+--
Changes (by Samdney):

 * owner:  iwakeh => Samdney
 * status:  needs_review => assigned


--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #20546 [Metrics/CollecTor]: implement CleanUtils

[Tor Bug Tracker & Wiki]

#20546: implement CleanUtils
---+--
 Reporter:  iwakeh |  Owner:  iwakeh
 Type:  enhancement| Status:  needs_review
 Priority:  Medium |  Milestone:
Component:  Metrics/CollecTor  |Version:
 Severity:  Normal | Resolution:
 Keywords:  metrics-help   |  Actual Points:
Parent ID:  #20518 | Points:
 Reviewer: |Sponsor:
---+--
Changes (by iwakeh):

 * status:  assigned => needs_review
 * keywords:   => metrics-help


Comment:

 What's open:

 * almost 300 checkstyle complaints (line lengths, indentation, and
 whitespace mostly)
 * use getFileName method in FileVisitor
 * verify tests and try to adapt them more closely to CollecTor use cases

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #20546 [Metrics/CollecTor]: implement CleanUtils

[Tor Bug Tracker & Wiki]

#20546: implement CleanUtils
---+--
 Reporter:  iwakeh |  Owner:  iwakeh
 Type:  enhancement| Status:  assigned
 Priority:  Medium |  Milestone:
Component:  Metrics/CollecTor  |Version:
 Severity:  Normal | Resolution:
 Keywords: |  Actual Points:
Parent ID:  #20518 | Points:
 Reviewer: |Sponsor:
---+--
Changes (by iwakeh):

 * owner:  aegis2501 => iwakeh
 * status:  needs_review => assigned
 * keywords:  metrics-help =>


Comment:

 Removed metrics-help tag, as this is already implemented.

 Review assigned to myself.

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #20546 [Metrics/CollecTor]: implement CleanUtils

[Tor Bug Tracker & Wiki]

#20546: implement CleanUtils
---+--
 Reporter:  iwakeh |  Owner:  aegis2501
 Type:  enhancement| Status:  needs_review
 Priority:  Medium |  Milestone:
Component:  Metrics/CollecTor  |Version:
 Severity:  Normal | Resolution:
 Keywords:  metrics-help   |  Actual Points:
Parent ID:  #20518 | Points:
 Reviewer: |Sponsor:
---+--
Changes (by iwakeh):

 * status:  reopened => needs_review


--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #20546 [Metrics/CollecTor]: implement CleanUtils

[Tor Bug Tracker & Wiki]

#20546: implement CleanUtils
---+---
 Reporter:  iwakeh |  Owner:  aegis2501
 Type:  enhancement| Status:  reopened
 Priority:  Medium |  Milestone:
Component:  Metrics/CollecTor  |Version:
 Severity:  Normal | Resolution:
 Keywords:  metrics-help   |  Actual Points:
Parent ID:  #20518 | Points:
 Reviewer: |Sponsor:
---+---
Changes (by iwakeh):

 * status:  closed => reopened
 * resolution:  implemented =>


Comment:

 Setting to reopen and then needs_review, to prevent this code from being
 forgotten and follow the usual process.

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #20546 [Metrics/CollecTor]: implement CleanUtils

[Tor Bug Tracker & Wiki]

#20546: implement CleanUtils
---+-
 Reporter:  iwakeh |  Owner:  aegis2501
 Type:  enhancement| Status:  closed
 Priority:  Medium |  Milestone:
Component:  Metrics/CollecTor  |Version:
 Severity:  Normal | Resolution:  implemented
 Keywords:  metrics-help   |  Actual Points:
Parent ID:  #20518 | Points:
 Reviewer: |Sponsor:
---+-
Changes (by aegis2501):

 * status:  assigned => closed
 * resolution:   => implemented


--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #20546 [Metrics/CollecTor]: implement CleanUtils

[Tor Bug Tracker & Wiki]

#20546: implement CleanUtils
---+---
 Reporter:  iwakeh |  Owner:  aegis2501
 Type:  enhancement| Status:  assigned
 Priority:  Medium |  Milestone:
Component:  Metrics/CollecTor  |Version:
 Severity:  Normal | Resolution:
 Keywords:  metrics-help   |  Actual Points:
Parent ID:  #20518 | Points:
 Reviewer: |Sponsor:
---+---

Comment (by aegis2501):

 Additional tests have been added:

 
https://github.com/aegis2501/CollecTor/blob/master/src/test/java/org/torproject/collector/persist/CleanUtilsTest.java

 I've come realize that these additional tests may not be very meaningful
 however, as they test the implementation of CleanUtils rather than
 requirements.

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #20546 [Metrics/CollecTor]: implement CleanUtils

[Tor Bug Tracker & Wiki]

#20546: implement CleanUtils
---+---
 Reporter:  iwakeh |  Owner:  aegis2501
 Type:  enhancement| Status:  assigned
 Priority:  Medium |  Milestone:
Component:  Metrics/CollecTor  |Version:
 Severity:  Normal | Resolution:
 Keywords:  metrics-help   |  Actual Points:
Parent ID:  #20518 | Points:
 Reviewer: |Sponsor:
---+---

Comment (by aegis2501):

 Replying to [comment:7 iwakeh]:
 > Cool!
 >
 > I didn't look deeply, e.i. think my way through the code, yet, but it's
 a very clean style.
 > Your test coverage is also up to 93% for CleanUtils, great.  (I didn't
 reply to your question
 > in comment:5, because trac doesn't mail anything for edited comments.
 So I didn't see the question.)
 >
 > Maybe, try to think up some tests that trigger exceptions and also to
 find out, what happens when unexpected input is given, like `null` or
 empty Strings or a file disappeared before being erased or never existed
 etc.
 >
 > And, we also have a Checkstyle and task `ant checks`, which currently
 complains a little about CleanUtils and CleanUtilsTest.  Nothing dramatic,
 mostly indentation and spacing.
 > Could you get that to pass again?
 >
 > Thanks a lot for that work!

 No problem! I'll work on it.

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #20546 [Metrics/CollecTor]: implement CleanUtils

[Tor Bug Tracker & Wiki]

#20546: implement CleanUtils
---+---
 Reporter:  iwakeh |  Owner:  aegis2501
 Type:  enhancement| Status:  assigned
 Priority:  Medium |  Milestone:
Component:  Metrics/CollecTor  |Version:
 Severity:  Normal | Resolution:
 Keywords:  metrics-help   |  Actual Points:
Parent ID:  #20518 | Points:
 Reviewer: |Sponsor:
---+---

Comment (by iwakeh):

 Cool!

 I didn't look deeply, e.i. think my way through the code, yet, but it's a
 very clean style.
 Your test coverage is also up to 93% for CleanUtils, great.  (I didn't
 reply to your question
 in comment:6, because trac doesn't mail anything for edited comments.  So
 I didn't see the question.)

 Maybe, try to think up some tests that trigger exceptions and also to find
 out, what happens when unexpected input is given, like `null` or empty
 Strings or a file disappeared before being erased or never existed etc.

 And, we also have a Checkstyle and task `ant checks`, which currently
 complains a little about CleanUtils and CleanUtilsTest.  Nothing dramatic,
 mostly indentation and spacing.
 Could you get that to pass again?

 Thanks a lot for that work!

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #20546 [Metrics/CollecTor]: implement CleanUtils

[Tor Bug Tracker & Wiki]

#20546: implement CleanUtils
---+---
 Reporter:  iwakeh |  Owner:  aegis2501
 Type:  enhancement| Status:  assigned
 Priority:  Medium |  Milestone:
Component:  Metrics/CollecTor  |Version:
 Severity:  Normal | Resolution:
 Keywords:  metrics-help   |  Actual Points:
Parent ID:  #20518 | Points:
 Reviewer: |Sponsor:
---+---

Comment (by aegis2501):

 Replying to [comment:4 iwakeh]:
 > Great!  Help is very much appreciated.
 >
 > There is a section
 
[https://trac.torproject.org/projects/tor/wiki/org/teams/MetricsTeam/Volunteers#Howtocontribute
 How to contribute] in our wiki.
 > If you have any questions, just ask here.
 >
 > Please assign this ticket to your user name when you start working.
 >
 > Thanks a lot!
 >

 Hi. I think I'm done: https://github.com/aegis2501/CollecTor

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #20546 [Metrics/CollecTor]: implement CleanUtils

[Tor Bug Tracker & Wiki]

#20546: implement CleanUtils
---+---
 Reporter:  iwakeh |  Owner:  aegis2501
 Type:  enhancement| Status:  assigned
 Priority:  Medium |  Milestone:
Component:  Metrics/CollecTor  |Version:
 Severity:  Normal | Resolution:
 Keywords:  metrics-help   |  Actual Points:
Parent ID:  #20518 | Points:
 Reviewer: |Sponsor:
---+---
Changes (by aegis2501):

 * status:  new => assigned
 * owner:   => aegis2501


--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #20546 [Metrics/CollecTor]: implement CleanUtils

[Tor Bug Tracker & Wiki]

#20546: implement CleanUtils
---+-
 Reporter:  iwakeh |  Owner:
 Type:  enhancement| Status:  new
 Priority:  Medium |  Milestone:
Component:  Metrics/CollecTor  |Version:
 Severity:  Normal | Resolution:
 Keywords:  metrics-help   |  Actual Points:
Parent ID:  #20518 | Points:
 Reviewer: |Sponsor:
---+-

Comment (by iwakeh):

 Great!  Help is very much appreciated.

 There is a section
 
[https://trac.torproject.org/projects/tor/wiki/org/teams/MetricsTeam/Volunteers#Howtocontribute
 How to contribute] in our wiki.
 If you have any questions, just ask here.

 Please assign this ticket to your user name when you start working.

 Thanks a lot!

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #20546 [Metrics/CollecTor]: implement CleanUtils

[Tor Bug Tracker & Wiki]

#20546: implement CleanUtils
---+-
 Reporter:  iwakeh |  Owner:
 Type:  enhancement| Status:  new
 Priority:  Medium |  Milestone:
Component:  Metrics/CollecTor  |Version:
 Severity:  Normal | Resolution:
 Keywords:  metrics-help   |  Actual Points:
Parent ID:  #20518 | Points:
 Reviewer: |Sponsor:
---+-

Comment (by aegis2501):

 Hello, could I help with this?

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #20546 [Metrics/CollecTor]: implement CleanUtils

[Tor Bug Tracker & Wiki]

#20546: implement CleanUtils
---+-
 Reporter:  iwakeh |  Owner:
 Type:  enhancement| Status:  new
 Priority:  Medium |  Milestone:
Component:  Metrics/CollecTor  |Version:
 Severity:  Normal | Resolution:
 Keywords:  metrics-help   |  Actual Points:
Parent ID:  #20518 | Points:
 Reviewer: |Sponsor:
---+-
Changes (by iwakeh):

 * keywords:  metrics_help => metrics-help


--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #20546 [Metrics/CollecTor]: implement CleanUtils

[Tor Bug Tracker & Wiki]

#20546: implement CleanUtils
---+-
 Reporter:  iwakeh |  Owner:
 Type:  enhancement| Status:  new
 Priority:  Medium |  Milestone:
Component:  Metrics/CollecTor  |Version:
 Severity:  Normal | Resolution:
 Keywords:  metrics_help   |  Actual Points:
Parent ID:  #20518 | Points:
 Reviewer: |Sponsor:
---+-
Changes (by iwakeh):

 * keywords:   => metrics_help


Comment:

 Excellent ticket for hack-days.

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

[tor-bugs] #20546 [Metrics/CollecTor]: implement CleanUtils

[Tor Bug Tracker & Wiki]

#20546: implement CleanUtils
---+
 Reporter:  iwakeh |  Owner:
 Type:  enhancement| Status:  new
 Priority:  Medium |  Milestone:
Component:  Metrics/CollecTor  |Version:
 Severity:  Normal |   Keywords:
Actual Points: |  Parent ID:  #20518
   Points: |   Reviewer:
  Sponsor: |
---+
 Create a `org.torproject.collector.persist.CleanUtils` class, which should
 offer the methods listed below.  First create the corresponding
 `org.torproject.collector.persist.CleanUtilsTest` class for all these
 methods.  After that make the tests pass.

 Use `Files.walkFileTree()` and `SimpleFileVisitor` for the implementation.

 1. Basic clean-up method:

 {{{
 #!java
 /**
  *  All files in the given directory and below are inspected and
  * erased, if they are older than the given cut-off-time.
 */
 public static void cleanDir(Path directory, long cutOffTime) {...}
 }}}

 2. Remove files with a certain ending:

 {{{
 #!java
 /**
  *  All files in the given directory and below are inspected and
  * erased, if they are older than the given cut-off-time, and their name
  * ends with one of the given patterns.
 */
 public static void cleanDirPattern(Path directory, long cutOffTime,
 String ... endingStrings) {...}
 }}}

 3. Some renaming methods:

 {{{
 #!java
 /**
  *  All files in the given directory and below are inspected and renamed
  * from  to , if their name ends with the
 given
  * 'ending'.
 */
 public static void renameFiles(Path directory, String ending) {...}


 /**
  *  All files in the given directory and below are inspected and renamed
  * from .tmp to , if their name ends with '.tmp'.
 */
 public static void renameTmpFiles(Path directory) {
   renameFiles(directory, ".tmp");
 }
 }}}

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs