Page MenuHomePhabricator

[services] Tests - Add add_attachments
ClosedPublic

Authored by karol on Jun 13 2022, 6:50 AM.
Tags
None
Referenced Files
F3502602: D4247.id14326.diff
Fri, Dec 20, 4:25 AM
F3502601: D4247.id14027.diff
Fri, Dec 20, 4:25 AM
F3502598: D4247.id13886.diff
Fri, Dec 20, 4:25 AM
F3502597: D4247.id13710.diff
Fri, Dec 20, 4:25 AM
F3502596: D4247.id13468.diff
Fri, Dec 20, 4:25 AM
F3502525: D4247.id.diff
Fri, Dec 20, 4:24 AM
F3502470: D4247.diff
Fri, Dec 20, 4:16 AM
F3500574: D4247.id14326.diff
Fri, Dec 20, 2:00 AM

Details

Summary

Depends on D4376

Adding the code for adding attachments to log/backup.

Test Plan

This change is eventually tested on the end of this stack when the logic for the backup test is added

Diff Detail

Repository
rCOMM Comm
Lint
No Lint Coverage
Unit
No Test Coverage

Event Timeline

Harbormaster returned this revision to the author for changes because remote builds failed.Jun 13 2022, 10:01 AM
Harbormaster failed remote builds in B9723: Diff 13468!

CI failed on an unrelated stage - key server
CI services build - no space left on device

tomek requested changes to this revision.Jun 20 2022, 4:27 AM
tomek added inline comments.
services/commtest/tests/backup/add_attachments.rs
11 ↗(On Diff #13468)

Can we remove it?

14–15 ↗(On Diff #13468)

Please be consistent in your comments. Is it logIndex or log_index?

23–31 ↗(On Diff #13468)

We should merge these. The current approach makes it harder to maintain the consistency.

36 ↗(On Diff #13468)

Why do we need to do so much here (take a reference, convert to_string, take a slice)? Please find a way to simplify it.

47 ↗(On Diff #13468)

Use shorthand

This revision now requires changes to proceed.Jun 20 2022, 4:27 AM
karol edited the summary of this revision. (Show Details)
karol edited the test plan for this revision. (Show Details)

address feedback

services/commtest/tests/backup/add_attachments.rs
11 ↗(On Diff #13468)

yes, sorry

14–15 ↗(On Diff #13468)

log_index, I'll fix this

23–31 ↗(On Diff #13468)

totally, thx

36 ↗(On Diff #13468)

this function requires str slice and we have a char. This is just one way we can do this that allocates memory on the heap.

We can also do this by using https://doc.rust-lang.org/std/primitive.char.html#method.encode_utf8

I honestly do not see much of a difference between these two approaches, the code that uses encode_utf8 looks like this:

let mut buff = [0; 1];
ATTACHMENT_DELIMITER.encode_utf8(&mut buff);
let attachments: String = match log_index {
  Some(log_index) => backup_data.log_items[log_index]
    .attachments_holders
    .join(ATTACHMENT_DELIMITER.encode_utf8(&mut buff)),
  None => backup_data
    .backup_item
    .attachments_holders
    .join(ATTACHMENT_DELIMITER.encode_utf8(&mut buff)),
};
tomek added inline comments.
services/commtest/tests/backup/add_attachments.rs
36 ↗(On Diff #13468)

What do you think about changing ATTACHMENT_DELIMITER to be a string slice then?

varun requested changes to this revision.Jun 26 2022, 9:27 PM
varun added inline comments.
services/commtest/tests/backup/add_attachments.rs
44–51 ↗(On Diff #13710)

shouldn't we check what is returned here?

This revision now requires changes to proceed.Jun 26 2022, 9:27 PM
varun requested changes to this revision.Jun 28 2022, 10:11 AM
varun added inline comments.
services/commtest/tests/backup/add_attachments.rs
44–51 ↗(On Diff #13710)

bumping this q

This revision now requires changes to proceed.Jun 28 2022, 10:11 AM

Sorry, forgot to hit submit

services/commtest/tests/backup/add_attachments.rs
44–51 ↗(On Diff #13710)

What do you mean? This function returns Result and I'm using ? so we do this. Can you specify what you mean?

36 ↗(On Diff #13468)

That solves the problem, will do, thanks!

tomek added inline comments.
services/commtest/tests/lib/tools.rs
21

It isn't a dead code

varun requested changes to this revision.Jun 29 2022, 3:03 PM
varun added inline comments.
services/commtest/tests/backup/add_attachments.rs
44–51 ↗(On Diff #13710)

I'm wondering if add_attachments returns anything noteworthy in the Ok variant that we should inspect. If the return type of that function is Result<(), SomeError> we can just remove the semicolon on this line and remove the Ok(())` on line 52

This revision now requires changes to proceed.Jun 29 2022, 3:03 PM
karol added inline comments.
services/commtest/tests/backup/add_attachments.rs
44–51 ↗(On Diff #13710)

It returns tonic::Response, so I'd leave this code as is.

services/commtest/tests/lib/tools.rs
21

For some reason Rust perceives it as a dead code, that's why I added this line to suppress the fake warnings:

warning: constant is never used: `ATTACHMENT_DELIMITER`
  --> tests/./lib/tools.rs:36:1
   |
36 | pub const ATTACHMENT_DELIMITER: &str = ";";
   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   |
   = note: `#[warn(dead_code)]` on by default

warning: constant is never used: `ATTACHMENT_DELIMITER`
  --> tests/./blob/../lib/tools.rs:36:1
   |
36 | pub const ATTACHMENT_DELIMITER: &str = ";";
   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

warning: `commtest` (test "tunnelbroker_test") generated 1 warning
warning: constant is never used: `ATTACHMENT_DELIMITER`
  --> tests/./backup/../lib/tools.rs:36:1
   |
36 | pub const ATTACHMENT_DELIMITER: &str = ";";
   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   |
   = note: `#[warn(dead_code)]` on by default

The number of lines are different as I tested this on the top of the stack.

varun added inline comments.
services/commtest/tests/lib/tools.rs
21

I arc patched this diff and there's no warning when i remove the `#[allow(dead_code)]
` line

This revision is now accepted and ready to land.Jun 30 2022, 2:56 PM
services/commtest/tests/lib/tools.rs
21

what command did you invoke to check this?

services/commtest/tests/lib/tools.rs
21

cargo build

services/commtest/tests/lib/tools.rs
21

Yeah, cargo build doesn't even touch this. Try to edit any test .rs file and make a syntax error like this:

async fn blob_test() -> Result<(), Error> {blah blah blah
  let port = env::var("COMM_SERVICES_PORT_BLOB")

Now, cargo build doesn't see this. You have to run cargo test to see the error.

This revision was automatically updated to reflect the committed changes.