Sidebar
This is an old revision of the document!
Table of Contents
BACKGROUND
Building on top of what we did in sln0 of making pseudocode and pictures of what happened in our pseudocode. We are actually starting to implement that into actual c code. The pseudocode and pictures should give you a good idea of what we are actually trying to accomplish in this project, sln1.
SPECIFICATIONS
In simple words, after you've grabbed the project files, it is our task to edit the cp.c mk.c, and rm.c files inside the 'sln1/src/node/ ' directory and make them work.
We have many files for reference at our disposal. The most important files to execute, read, and analyze are contained within the 'sln1/unit/node/ ' directory. These source code files will be your guides, to get your files to work.
As explained down below in the Unit Test section, another set of important files is contained within the 'sln1/bin/ ' directory. Run these files for testing.
You will find a “node.h” file in the provided include directory (sln1/inc/node.h) which provides a struct node that will serve as the structure of the Node that you will be manipulating
Reminder
Whenever you allocate a resource, check that the memory allocation, be that for a file or a pointer, is valid. In other words, check that your pointer/file is not NULL.
Our task is to ask questions on Discord or in class and document our findings on this wiki page collaboratively, regarding the functionality of this project. For anybody interested in editing the wiki page, here is the dokuwiki user guide: https://www.dokuwiki.org/wiki:syntax#basic_text_formatting -Ash
PROGRAM
Program should be able to perform specifications displayed inside the files. For example, inside src/node/mk.c, rm.c, and cp.c should be able to make nodes, remove nodes, and copy nodes, respectively. Some files inside app/node/ have little to no needed code and only test your src/node/ files. If your files are made correctly and to project specifications it should work well and similar to some of your sln0 pseudocode. Most, if not all, of the specifications will be commented inside the files with what you need to do.
Directories containing vital project information:
/src/node//app/node//unit/node//inc/
/inc/contains your header files used in most programs/unit/node/contains your unit tests for mk.c, rm.c, and cp.c/src/node/contains the mk.c, rm.c, and cp.c files/app/node/is the main part of the project and your tasks to do
OUTPUT SPECIFICATIONS
This may refer to output in regards to the /app/node/ files.
update with more information
UNIT TESTS
It is part of our evaluation to get as many tests as possible to match. Ideally, all should match.
For your initial unit tests of mknode(), cpnode(), and rmnode() you need to build your unit tests first. To do this you are going to want to run make all inside of your src/node folder. Alternatively, you can run the make command on your base sln1 directory. If you don't do this, the next makefile will produce errors. This process can be done on lab46 or a linux-esque device(your pi), however implementation on other OS is not guaranteed. The example will be using lab46.
USERNAME@lab46:~/src/fall2022/sln1/src/node$ make all Building the NODE library ======================================= [CC] cp.c ... OK [CC] mk.c ... OK [CC] rm.c ... OK libnode.{a,so} ... SUCCESS
Afterwards, you will want to navigate to the unit/node directory and run make all there as well.
USERNAME@lab46:~/src/fall2022/sln1/unit/node$ make all Building NODE library unit tests ======================================= [CC] unit-cpnode.c ... OK [CC] unit-mknode.c ... OK [CC] unit-rmnode.c ... OK [CP] Copying to sln1/bin/ ... SUCCESS
Afterwards, your unit tests will be available inside of the bin folder of your sln1 directory. Run these by executing the verify scripts. Example outputs are below.
CP Node Verify:
USERNAME@lab46:~/src/fall2022/sln1/bin$ ./verify-cpnode.sh [test 0] MATCH [test 1] MATCH [test 2] MATCH [test 3] MATCH [test 4] MATCH Total: 5, Matches: 5, Mismatches: 0
MK Node Verify:
USERNAME@lab46:~/src/fall2022/sln1/bin$ ./verify-mknode.sh [test 0] MATCH [test 1] MATCH [test 2] MATCH [test 3] MATCH Total: 4, Matches: 4, Mismatches: 0
RM Node Verify:
USERNAME@lab46:~/src/fall2022/sln1/bin$ ./verify-rmnode.sh [test 0] MATCH [test 1] MATCH Total: 2, Matches: 2, Mismatches: 0
Another set of useful commands are:
USERNAME@lab46:~/src/fall2022/sln1/bin$ Make helpMake help displays all available options for the Make command
USERNAME@lab46:~/src/fall2022/sln1/bin$ Make checkMake check will help you verify that the implementation of your nodes is functional.
