summaryrefslogtreecommitdiff
path: root/python-ts-ids-es-json-generator.spec
blob: db593e8da1081b74fc17ec6ca9afda17bbf6a9a2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
%global _empty_manifest_terminate_build 0
Name:		python-ts-ids-es-json-generator
Version:	1.0.1
Release:	1
Summary:	Python utility for generating elasticsearch.json from schema.json for an IDS
License:	Apache License 2.0
URL:		https://github.com/tetrascience/ts-ids-es-json-generator
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/d5/1c/c0b68d36010671a96d922040634515e4acdc5da8cb939f1658dea7a1fc6c/ts-ids-es-json-generator-1.0.1.tar.gz
BuildArch:	noarch

Requires:	python3-jsonref
Requires:	python3-pydash

%description
# ts-ids-es-json-generator

## Introduction

This simple utility generates `elasticsearch.json` using `schema.json`.

## How to Use

To run the generator, simply provide the program with the location of the IDS root directory:

```
$ pipenv run python -m ids_es_json_generator ~/path/to/ids/folder
```

`elasticsearch.json` may be manually edited after automatic generation (e.g. to update non-searchable fields).

## Output

The script saves `elasticsearch.json` to the same directory you provided.

## Assumptions

The generator operates under the following assumptions:

- It's the IDS designer's responsibility to make sure the schema and `elasticsearch.json` are correct.
  The generator will not validate the IDS for you.

## Restrictions

- JSON pointers are dereferenced to create the mapping, so schemas with circular references or missing references will fail.

## Tests

Run the tests using the following command:

`$ pipenv run python -m pytest`

## How it works

Anywhere an array of objects appears in the schema, a `nested` field type will be created in the output `elasticsearch.json`, including arrays of objects contained anywhere within other arrays of objects.
The steps are:

1. The schema is loaded into a dict with all of its JSON pointers dereferenced using `jsonref`, so that nested fields involving `definitions` are included in the elasticsearch mapping.
2. `find_array_object` will find all arrays of objects and create a dict representing their locations in the schema (see test case `test_array_simple_nested_case` in `__tests__/unit/test_find_array_object.py`).
3. `generate_es_mapping` uses this dict to create the elasticsearch mapping (see test case `test_nested_keys_case` in `__tests__/unit/test_generate_es_mapping.py`).

See the example files and test cases for more example usage.




%package -n python3-ts-ids-es-json-generator
Summary:	Python utility for generating elasticsearch.json from schema.json for an IDS
Provides:	python-ts-ids-es-json-generator
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-ts-ids-es-json-generator
# ts-ids-es-json-generator

## Introduction

This simple utility generates `elasticsearch.json` using `schema.json`.

## How to Use

To run the generator, simply provide the program with the location of the IDS root directory:

```
$ pipenv run python -m ids_es_json_generator ~/path/to/ids/folder
```

`elasticsearch.json` may be manually edited after automatic generation (e.g. to update non-searchable fields).

## Output

The script saves `elasticsearch.json` to the same directory you provided.

## Assumptions

The generator operates under the following assumptions:

- It's the IDS designer's responsibility to make sure the schema and `elasticsearch.json` are correct.
  The generator will not validate the IDS for you.

## Restrictions

- JSON pointers are dereferenced to create the mapping, so schemas with circular references or missing references will fail.

## Tests

Run the tests using the following command:

`$ pipenv run python -m pytest`

## How it works

Anywhere an array of objects appears in the schema, a `nested` field type will be created in the output `elasticsearch.json`, including arrays of objects contained anywhere within other arrays of objects.
The steps are:

1. The schema is loaded into a dict with all of its JSON pointers dereferenced using `jsonref`, so that nested fields involving `definitions` are included in the elasticsearch mapping.
2. `find_array_object` will find all arrays of objects and create a dict representing their locations in the schema (see test case `test_array_simple_nested_case` in `__tests__/unit/test_find_array_object.py`).
3. `generate_es_mapping` uses this dict to create the elasticsearch mapping (see test case `test_nested_keys_case` in `__tests__/unit/test_generate_es_mapping.py`).

See the example files and test cases for more example usage.




%package help
Summary:	Development documents and examples for ts-ids-es-json-generator
Provides:	python3-ts-ids-es-json-generator-doc
%description help
# ts-ids-es-json-generator

## Introduction

This simple utility generates `elasticsearch.json` using `schema.json`.

## How to Use

To run the generator, simply provide the program with the location of the IDS root directory:

```
$ pipenv run python -m ids_es_json_generator ~/path/to/ids/folder
```

`elasticsearch.json` may be manually edited after automatic generation (e.g. to update non-searchable fields).

## Output

The script saves `elasticsearch.json` to the same directory you provided.

## Assumptions

The generator operates under the following assumptions:

- It's the IDS designer's responsibility to make sure the schema and `elasticsearch.json` are correct.
  The generator will not validate the IDS for you.

## Restrictions

- JSON pointers are dereferenced to create the mapping, so schemas with circular references or missing references will fail.

## Tests

Run the tests using the following command:

`$ pipenv run python -m pytest`

## How it works

Anywhere an array of objects appears in the schema, a `nested` field type will be created in the output `elasticsearch.json`, including arrays of objects contained anywhere within other arrays of objects.
The steps are:

1. The schema is loaded into a dict with all of its JSON pointers dereferenced using `jsonref`, so that nested fields involving `definitions` are included in the elasticsearch mapping.
2. `find_array_object` will find all arrays of objects and create a dict representing their locations in the schema (see test case `test_array_simple_nested_case` in `__tests__/unit/test_find_array_object.py`).
3. `generate_es_mapping` uses this dict to create the elasticsearch mapping (see test case `test_nested_keys_case` in `__tests__/unit/test_generate_es_mapping.py`).

See the example files and test cases for more example usage.




%prep
%autosetup -n ts-ids-es-json-generator-1.0.1

%build
%py3_build

%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
	find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
	find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
	find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
	find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
	find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .

%files -n python3-ts-ids-es-json-generator -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Tue May 30 2023 Python_Bot <Python_Bot@openeuler.org> - 1.0.1-1
- Package Spec generated